plugin::media_injection_status

🚀

SDK Beta

This structure is a part of the Beta program.

Module: Default Media Injector Plugin

The current media injection status is expressed via this structure. This structure can be passed to the application by the injector to describe the current status.

#include <injector.h>

Public Types

Name
enumtype { VIDEO, AUDIO = 1}
The type of media this status is for.
enumstate { STOPPED = 0, INJECTING, ERROR}
Enum describing the state of the media.

Public Functions

Name
~media_injection_status()
media_injection_status(type type)
Constructor taking only the media type.
media_injection_status(type type, state state, const std::string & description ={})
Explicit constructor taking the type, state and extra description.

Public Attributes

struct dolbyio::comms::plugin::media_injection_status;

Public Types Documentation

enum type

EnumeratorDescription
VIDEO
AUDIO

The type of media this status is for.

enum state

EnumeratorDescription
STOPPED
INJECTING
ERROR

Enum describing the state of the media.

Public Functions Documentation

function ~media_injection_status

~media_injection_status()

Default destructor.

function media_injection_status

media_injection_status(
    type type
)

Constructor taking only the media type.

Parameters:

  • type Enum value describing the type of media.

function media_injection_status

media_injection_status(
    type type,
    state state,
    const std::string & description ={}
)

Explicit constructor taking the type, state and extra description.

Parameters:

  • type Enum value describing the type of media.
  • state Enum value describing the state.
  • description Extra description of current media state.

Public Attributes Documentation

variable type_

type type_;

Holds the value of the type of media

variable state_

state state_ {
      STOPPED};

Holds the value of current state for single media

variable description_

std::string description_ {};

Holds the value of any extra description of current state for single media



Did this page help you?