Enum PublishPolicy

#[repr(i32)]
pub enum PublishPolicy {
    Optional = 0,
    Required = 1,
    Disabled = 2,
}

Policy of how a video or an audio media type can be published in a WebRtcPublishEndpoint.

Variants

Optional = 0

Media type MAY be published.

Media server will try to initialize publishing, but won’t produce any errors if user application fails to (or chooses not to) acquire the required media track. Media server will approve user requests to stop and to restart publishing the specified media type.

Required = 1

Media type MUST be published.

Media server will try to initialize publishing, and if the required media track cannot be acquired, then an error will be thrown. Media server will deny all requests to stop publishing.

Disabled = 2

Media type MUST NOT be published.

Media server will not try to initialize publishing.

Implementations

impl PublishPolicy

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of PublishPolicy.

pub fn from_i32(value: i32) -> Option<PublishPolicy>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a PublishPolicy, or None if value is not a valid variant.

impl PublishPolicy

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for PublishPolicy

fn clone(&self) -> PublishPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublishPolicy

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

Formats the value using the given formatter.

impl Default for PublishPolicy

fn default() -> PublishPolicy

Returns the “default value” for a type.

impl From<Policy> for PublishPolicy

fn from(val: Policy) -> Self

Converts to this type from the input type.

impl From<PublishPolicy> for Policy

fn from(val: PublishPolicy) -> Self

Converts to this type from the input type.

impl From<PublishPolicy> for i32

fn from(value: PublishPolicy) -> i32

Converts to this type from the input type.

impl Hash for PublishPolicy

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 PublishPolicy

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

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

fn partial_cmp(&self, other: &PublishPolicy) -> 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 TryFrom<i32> for PublishPolicy

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<PublishPolicy, UnknownEnumValue>

Performs the conversion.

impl Copy for PublishPolicy

impl Eq for PublishPolicy

impl StructuralPartialEq for PublishPolicy