Enum gstreamer_video::NavigationCommand

#[non_exhaustive]
pub enum NavigationCommand {
    Invalid,
    Menu1,
    Menu2,
    Menu3,
    Menu4,
    Menu5,
    Menu6,
    Menu7,
    Left,
    Right,
    Up,
    Down,
    Activate,
    PrevAngle,
    NextAngle,
}

A set of commands that may be issued to an element providing the Navigation interface. The available commands can be queried via the gst_navigation_query_new_commands() query.

For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_MENU = Menu1 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = Menu2 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = Menu3 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = Menu4 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = Menu5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = Menu6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = Menu7

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Invalid

An invalid command entry

Menu1

Execute navigation menu command 1. For DVD, this enters the DVD root menu, or exits back to the title from the menu.

Menu2

Execute navigation menu command 2. For DVD, this jumps to the DVD title menu.

Menu3

Execute navigation menu command 3. For DVD, this jumps into the DVD root menu.

Menu4

Execute navigation menu command 4. For DVD, this jumps to the Subpicture menu.

Menu5

Execute navigation menu command 5. For DVD, the jumps to the audio menu.

Menu6

Execute navigation menu command 6. For DVD, this jumps to the angles menu.

Menu7

Execute navigation menu command 7. For DVD, this jumps to the chapter menu.

Left

Select the next button to the left in a menu, if such a button exists.

Right

Select the next button to the right in a menu, if such a button exists.

Up

Select the button above the current one in a menu, if such a button exists.

Down

Select the button below the current one in a menu, if such a button exists.

Activate

Activate (click) the currently selected button in a menu, if such a button exists.

PrevAngle

Switch to the previous angle in a multiangle feature.

NextAngle

Switch to the next angle in a multiangle feature.

Trait Implementations

impl Clone for NavigationCommand

fn clone(&self) -> NavigationCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NavigationCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NavigationCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NavigationCommand> for Value

fn from(v: NavigationCommand) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for NavigationCommand

type Checker = GenericValueTypeChecker<NavigationCommand>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for NavigationCommand

type ParamSpec = ParamSpecEnum

type SetValue = NavigationCommand

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: NavigationCommand) -> ParamSpecEnumBuilder<'_, NavigationCommand>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for NavigationCommand

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 NavigationCommand

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

Restrict a value to a certain interval.

impl PartialEq for NavigationCommand

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticType for NavigationCommand

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for NavigationCommand

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for NavigationCommand

type Type = NavigationCommand

Type to get the Type from.

impl Copy for NavigationCommand

impl Eq for NavigationCommand

impl StructuralPartialEq for NavigationCommand