Struct RoomCompositeEgressRequest

pub struct RoomCompositeEgressRequest {

    pub room_name: String,
    pub layout: String,
    pub audio_only: bool,
    pub audio_mixing: i32,
    pub video_only: bool,
    pub custom_base_url: String,
    pub file_outputs: Vec<EncodedFileOutput>,
    pub stream_outputs: Vec<StreamOutput>,
    pub segment_outputs: Vec<SegmentedFileOutput>,
    pub image_outputs: Vec<ImageOutput>,
    pub webhooks: Vec<WebhookConfig>,
    pub output: Option<Output>,
    pub options: Option<Options>,
}

composite using a web browser

Fields

room_name: String

required

layout: String

(optional)

audio_only: bool

(default false)

audio_mixing: i32

only applies to audio_only egress (default DEFAULT_MIXING)

video_only: bool

(default false)

custom_base_url: String

template base url (default https://recorder.livekit.io)

file_outputs: Vec<EncodedFileOutput>

stream_outputs: Vec<StreamOutput>

segment_outputs: Vec<SegmentedFileOutput>

image_outputs: Vec<ImageOutput>

webhooks: Vec<WebhookConfig>

extra webhooks to call for this request

output: Option<Output>

deprecated (use _output fields)

options: Option<Options>

Implementations

impl RoomCompositeEgressRequest

pub fn audio_mixing(&self) -> AudioMixing

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

pub fn set_audio_mixing(&mut self, value: AudioMixing)

Sets audio_mixing to the provided enum value.

Trait Implementations

impl Clone for RoomCompositeEgressRequest

fn clone(&self) -> RoomCompositeEgressRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomCompositeEgressRequest

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

Formats the value using the given formatter.

impl Default for RoomCompositeEgressRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomCompositeEgressRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RoomCompositeEgressRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for RoomCompositeEgressRequest

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RoomCompositeEgressRequest