r5::common::MediaDesc Struct Reference

Unified media data description. More...

#include <r5data.h>

Collaboration diagram for r5::common::MediaDesc:

Public Member Functions
	MediaDesc (DataType t=DataType::Unknown)
	Default constructor Can specify data type and set all other fields to zero. More...
	MediaDesc (const MediaDesc &other)
	Copying constructor. More...
MediaDesc &	operator= (MediaDesc other)
	Assign MediaDesc value. More...
	MediaDesc (VideoFmt fmt, int32_t w=0, int32_t h=0, int32_t fps=0)
	Overriden constructor to create video data description Contructs object with type set to Video. More...
	MediaDesc (AudioFmt fmt, int32_t ch=0, int32_t sr=0)
	Overriden constructor to create audio data description Contructs object with type set to Audio. More...

Public Attributes
DataType	type
	Type of media described by structure. Defines what option of union to use.
union {
struct VideoDesc   video
	Description for Video data type.
struct AudioDesc   audio
	Description for Audio data type.
};

Detailed Description

Unified media data description.

Constructor & Destructor Documentation

MediaDesc() [1/4]

r5::common::MediaDesc::MediaDesc ( DataType  t = DataType::Unknown )

inline

Default constructor Can specify data type and set all other fields to zero.

Parameters

t	optional data type of media

MediaDesc() [2/4]

r5::common::MediaDesc::MediaDesc ( const MediaDesc &  other )

inline

Copying constructor.

Parameters

other

original object to copy

MediaDesc() [3/4]

r5::common::MediaDesc::MediaDesc ( VideoFmt  fmt, int32_t  w = 0, int32_t  h = 0, int32_t  fps = 0  )

inline

Overriden constructor to create video data description Contructs object with type set to Video.

Parameters

fmt	optional video pixel format
w	optional video frame width
h	optional video frame height
fps	optional video stream frame rate

MediaDesc() [4/4]

r5::common::MediaDesc::MediaDesc ( AudioFmt  fmt, int32_t  ch = 0, int32_t  sr = 0  )

inline

Overriden constructor to create audio data description Contructs object with type set to Audio.

Parameters

fmt	optional audio sample format
ch	optional number of audio channels
sr	optional audio stream sample rate

Member Function Documentation

operator=()

MediaDesc& r5::common::MediaDesc::operator= ( MediaDesc  other )

inline

Assign MediaDesc value.

Parameters

other

original object to copy

Returns

*this

---

The documentation for this struct was generated from the following file:

• dist/include/r5common/r5data.h