Struct CodecDescription

pub struct CodecDescription {
    pub codec_type: CodecType,
    pub mime_type: String,
    pub can_stream_bytes_input: bool,
    pub can_find_start: bool,
    pub can_re_sync: bool,
    pub will_report_all_detected_errors: bool,
    pub is_hw: bool,
    pub split_header_handling: bool,
}

Deprecated.

Rather than listening for OnCodecList, clients needing codec information prior to just requesting a codec with CodecFactory.CreateDecoder or CodecFactory.CreateEncoder should instead use GetDetailedCodecDescriptions to get the DetailedCodecDescription table instead, which has per-profile-entry equivalents of all these fields. Clients with no real need for codec information prior to requesting a codec can call CodecFactory.CreateDecoder or CodecFactory.CreateEncoder with relevant requirements set in that request, and then StreamProcessor.Sync to see if a codec was actually created successfully.

In contrast to OnCodecList which uses FIDL structs (due to ordering of historical events), GetDetailedCodecDescriptions uses FIDL tables so is not expected to need to be deprecated, since we can add new table fields as needed, and gradually deprecate old table fields if appropriate, without deprecating the whole thing.

Per-codec servers do not need to fill out this struct or send OnCodecList, as the main CodecFactory will construct the OnCodecList info from the GetDetailedCodecDescriptions info, so that each codec can (optionally) stop sending OnCodecList immediately, rather than having to wait for all clients to stop listening to OnCodecList, which may take a while. All codecs do need to implement GetDetailedCodecDescriptions however.

Fields

codec_type: CodecType

Decoder or encoder.

mime_type: String

The mime type of the compressed format. For decoders this is the mime type of the input. For encoders, this is the mime type of the output.

can_stream_bytes_input: bool

For each of these fields, the default is the most-capable setting, but if a codec doesn’t support the most-capable behavior, then the codec must override the default.

can_find_start: bool

can_re_sync: bool

will_report_all_detected_errors: bool

is_hw: bool

split_header_handling: bool

Trait Implementations

impl Clone for CodecDescription

fn clone(&self) -> CodecDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodecDescription

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<CodecDescription, D> for CodecDescription

fn new_empty() -> Self

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<()>

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

impl<D: ResourceDialect> Encode<CodecDescription, D> for &CodecDescription

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

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

impl<D: ResourceDialect, T0: Encode<CodecType, D>, T1: Encode<BoundedString<256>, D>, T2: Encode<bool, D>, T3: Encode<bool, D>, T4: Encode<bool, D>, T5: Encode<bool, D>, T6: Encode<bool, D>, T7: Encode<bool, D>> Encode<CodecDescription, D> for (T0, T1, T2, T3, T4, T5, T6, T7)

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

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

impl Hash for CodecDescription

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CodecDescription

fn cmp(&self, other: &CodecDescription) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CodecDescription

fn eq(&self, other: &CodecDescription) -> 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 PartialOrd for CodecDescription

fn partial_cmp(&self, other: &CodecDescription) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for CodecDescription

type Owned = CodecDescription

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 CodecDescription

type Borrowed<'a> = &'a CodecDescription

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: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

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

impl Eq for CodecDescription

impl Persistable for CodecDescription

impl StructuralPartialEq for CodecDescription