Struct AttachmentConfig

pub struct AttachmentConfig {
    pub width: u32,
    pub height: u32,
    pub video_codec: Option<VideoCodec>,
    pub video_profile: Option<VideoProfile>,
    pub quality_preset: Option<u32>,
    pub audio_codec: Option<AudioCodec>,
    pub sample_rate: Option<u32>,
    pub channels: Vec<AudioChannel>,
    pub video_stream_seq_offset: u64,
    pub audio_stream_seq_offset: u64,
}

Fields

width: u32

The width of the video stream.

height: u32

The height of the video stream.

video_codec: Option<VideoCodec>

The codec to use for the video stream. Leaving it empty allows the server to decide.

video_profile: Option<VideoProfile>

The profile (bit depth and colorspace) to use for the video stream. Leaving it empty allows the server to decide.

quality_preset: Option<u32>

The quality preset, from 1-10. A None or 0 indicates the server should decide.

audio_codec: Option<AudioCodec>

The codec to use for the audio stream. Leaving it empty allows the server to decide.

sample_rate: Option<u32>

The sample rate to use for the audio stream. Leaving it empty allows the server to decide.

channels: Vec<AudioChannel>

The channel layout to use for the audio stream. An empty vec indicates the server should decide.

video_stream_seq_offset: u64

An offset to apply to the stream_seq of incoming video packets. The offset is applied on the client side, and exists as a convenient way to way to ensure sequence numbers stay monotonic, even across individual attachment streams.

audio_stream_seq_offset: u64

An offset to apply to the stream_seq of incoming audio packets. The offset is applied on the client side, and exists as a convenient way to way to ensure sequence numbers stay monotonic, even across individual attachment streams.

Trait Implementations

impl Clone for AttachmentConfig

fn clone(&self) -> AttachmentConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for AttachmentConfig

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for AttachmentConfig

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for AttachmentConfig

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for AttachmentConfig

type FfiType = <AttachmentConfig as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for AttachmentConfig

type LiftType = AttachmentConfig

impl<UT> LiftReturn<UT> for AttachmentConfig

type ReturnType = <AttachmentConfig as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for AttachmentConfig

type FfiType = <AttachmentConfig as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for AttachmentConfig

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for AttachmentConfig

type ReturnType = <AttachmentConfig as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for AttachmentConfig

const TYPE_ID_META: MetadataBuffer