Struct CreateIngressRequest

pub struct CreateIngressRequest {
    pub input_type: i32,
    pub url: String,
    pub name: String,
    pub room_name: String,
    pub participant_identity: String,
    pub participant_name: String,
    pub participant_metadata: String,
    pub bypass_transcoding: bool,
    pub enable_transcoding: Option<bool>,
    pub audio: Option<IngressAudioOptions>,
    pub video: Option<IngressVideoOptions>,
    pub enabled: Option<bool>,
}

Fields

input_type: i32

url: String

Where to pull media from, only for URL input type

name: String

User provided identifier for the ingress

room_name: String

room to publish to

participant_identity: String

publish as participant

participant_name: String

name of publishing participant (used for display only)

participant_metadata: String

metadata associated with the publishing participant

bypass_transcoding: bool

👎Deprecated

[depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use enable_transcoding instead.

enable_transcoding: Option<bool>

Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

audio: Option<IngressAudioOptions>

video: Option<IngressVideoOptions>

enabled: Option<bool>

The default value is true and when set to false, the new connection attempts will be rejected

Implementations

impl CreateIngressRequest

pub fn input_type(&self) -> IngressInput

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

pub fn set_input_type(&mut self, value: IngressInput)

Sets input_type to the provided enum value.

pub fn enable_transcoding(&self) -> bool

Returns the value of enable_transcoding, or the default value if enable_transcoding is unset.

pub fn enabled(&self) -> bool

Returns the value of enabled, or the default value if enabled is unset.

Trait Implementations

impl Clone for CreateIngressRequest

fn clone(&self) -> CreateIngressRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIngressRequest

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

Formats the value using the given formatter.

impl Default for CreateIngressRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateIngressRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CreateIngressRequest

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 CreateIngressRequest

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

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 CreateIngressRequest