Struct FormatDetails

pub struct FormatDetails {
    pub format_details_version_ordinal: Option<u64>,
    pub mime_type: Option<String>,
    pub oob_bytes: Option<Vec<u8>>,
    pub domain: Option<DomainFormat>,
    pub pass_through_parameters: Option<Vec<Parameter>>,
    pub encoder_settings: Option<EncoderSettings>,
    pub timebase: Option<u64>,
    pub profile: Option<CodecProfile>,
    /* private fields */
}

FormatDetails

This describes/details the format on input or output of a StreamProcessor (separate instances for input vs. output).

Fields

format_details_version_ordinal: Option<u64>

mime_type: Option<String>

oob_bytes: Option<Vec<u8>>

domain: Option<DomainFormat>

pass_through_parameters: Option<Vec<Parameter>>

encoder_settings: Option<EncoderSettings>

Instructs an encoder on how to encode raw data.

Decoders may ignore this field but are entitled to rejected requests with this field set because it doesn’t make sense.

timebase: Option<u64>

The number of ticks of the timebase of input packet timestamp_ish values per second.

The timebase is only used used for optional extrapolation of timestamp_ish values when an input timestamp which applies to byte 0 of the valid portion of the input packet does not correspond directly to byte 0 of the valid portion of any output packet.

Leave unset if timestamp extrapolation is not needed, either due to lack of timestamps on input, or due to input being provided in increments of the encoder’s input chunk size (based on the encoder settings and calculated independently by the client). Set if timestamp extrapolation is known to be needed or known to be acceptable to the client.

profile: Option<CodecProfile>

The codec profile for the given encoder or decoder.

For encoders: This value is completely optional. A client may want to specify the codec profile used for protocol compatibility reasons (i.e. WebRTC). However if the value is not set then the the encoder is free to choose any supported codec profile.

For decoders: This value is optional but providing it is best practice (at least of unencrypted streams). Container formats include the encoded profile and this should be provided to the decoder. Certain formats like VP9 and AV1 include the encoded profile in their elementary bitstream so it is possible for those decoders to figure out the profile the stream is encoded in. Regardless, clients should provide the encoded profile if possible.

Trait Implementations

impl Clone for FormatDetails

fn clone(&self) -> FormatDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormatDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<D> Decode<FormatDetails, D> for FormatDetails

where D: ResourceDialect,

fn new_empty() -> FormatDetails

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for FormatDetails

fn default() -> FormatDetails

Returns the “default value” for a type.

impl<D> Encode<FormatDetails, D> for &FormatDetails

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for FormatDetails

fn eq(&self, other: &FormatDetails) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for FormatDetails

type Owned = FormatDetails

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for FormatDetails

type Borrowed<'a> = &'a FormatDetails

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<FormatDetails as TypeMarker>::Owned, ) -> <FormatDetails as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for FormatDetails

impl StructuralPartialEq for FormatDetails