Struct Attach

pub struct Attach {
    pub session_id: u64,
    pub attachment_type: i32,
    pub client_name: String,
    pub video_codec: i32,
    pub streaming_resolution: Option<Size>,
    pub video_profile: i32,
    pub quality_preset: u32,
    pub audio_codec: i32,
    pub channels: Option<AudioChannels>,
    pub sample_rate_hz: u32,
}

030 - Attach

This message, which must originate from the client on a new stream, requests that the server attach the client to the named session. Upon receipt of this request, the server must either refuse the attachment with an 001 - Error message, or send an 031 - Attached message on the same stream and start sending video and audio packets to the client.

Ommitted fields indicate that the server should choose the parameters.

The server may choose to reject the attachment for any reason, including but not limited to:

• The output parameters, such as resolution or codec, are invalid or not supported.
• The server already has a client attached to that session, and wishes to limit the number of attachments (or doesn’t support multiple attachments).
• The authentication so far provided doesn’t grant the client access to that session with that attachment type.

Fields

session_id: u64

Required.

attachment_type: i32

Required.

client_name: String

video_codec: i32

streaming_resolution: Option<Size>

video_profile: i32

quality_preset: u32

Must be in the range 1-10.

audio_codec: i32

channels: Option<AudioChannels>

sample_rate_hz: u32

Implementations

impl Attach

pub fn attachment_type(&self) -> AttachmentType

Returns the enum value of attachment_type, or the default if the field is set to an invalid enum value.

pub fn set_attachment_type(&mut self, value: AttachmentType)

Sets attachment_type to the provided enum value.

pub fn video_codec(&self) -> VideoCodec

Returns the enum value of video_codec, or the default if the field is set to an invalid enum value.

pub fn set_video_codec(&mut self, value: VideoCodec)

Sets video_codec to the provided enum value.

pub fn video_profile(&self) -> VideoProfile

Returns the enum value of video_profile, or the default if the field is set to an invalid enum value.

pub fn set_video_profile(&mut self, value: VideoProfile)

Sets video_profile to the provided enum value.

pub fn audio_codec(&self) -> AudioCodec

Returns the enum value of audio_codec, or the default if the field is set to an invalid enum value.

pub fn set_audio_codec(&mut self, value: AudioCodec)

Sets audio_codec to the provided enum value.

Trait Implementations

impl Clone for Attach

fn clone(&self) -> Attach

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attach

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

Formats the value using the given formatter.

impl Default for Attach

fn default() -> Self

Returns the “default value” for a type.

impl From<Attach> for MessageType

fn from(v: Attach) -> Self

Converts to this type from the input type.

impl Message for Attach

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Attach

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