r5::common::MediaSample Struct Reference

Description of media sample used. More...

#include <r5data.h>

Collaboration diagram for r5::common::MediaSample:

Public Member Functions
	MediaSample ()
	Default constructor.
	MediaSample (MediaDesc mediaType, uint32_t dataSize, uint32_t ts)
	Allocation constrructor Will set values and allocate internal buffer based on paramters. More...
	MediaSample (MediaDesc mediaType, uint8_t *data, uint32_t dataSize, uint32_t ts)
	Initializing constructor Will set values, allocate and initialize internal buffer based on parameters. More...
	MediaSample (MediaDesc mediaType, char *data, uint32_t dataSize, uint32_t ts)
	Initializing constructor (char variant) Will set values, allocate and initialize internal buffer based on parameters. More...
	MediaSample (MediaDesc mediaType, std::unique_ptr< uint8_t[]> data, uint32_t dataSize, uint32_t ts)
	Initializing constructor Will set values, allocate and initialize internal buffer based on parameters Note: data pointer will be moved to internal buffer, so it will be no longer valid. More...
	MediaSample (MediaDesc mediaType, std::unique_ptr< char[]> data, uint32_t dataSize, uint32_t ts)
	Initializing constructor (char variant) Will set values, allocate and initialize internal buffer based on parameters Note: data pointer will be moved to internal buffer, so it will be no longer valid. More...
	~MediaSample ()
	Default destructor.
	MediaSample (MediaSample &other)
	Copying constructor. More...
MediaSample &	operator= (MediaSample &other)
	Assign MediaSample value. More...
	MediaSample (const MediaSample &other)
	Copying constructor. More...
MediaSample &	operator= (const MediaSample &other)
	Assign MediaSample value. More...

Public Attributes
MediaDesc	type
	media description of sample data
uint32_t	timestamp
	timestamp of sample in milliseconds
uint32_t	size
	size of sample data in bytes
std::unique_ptr< uint8_t[]>	buffer
	sample data

Detailed Description

Description of media sample used.

Constructor & Destructor Documentation

MediaSample() [1/7]

r5::common::MediaSample::MediaSample ( MediaDesc  mediaType, uint32_t  dataSize, uint32_t  ts  )

inline

Allocation constrructor Will set values and allocate internal buffer based on paramters.

Parameters

mediaType	media description of sample data
dataSize	size of sample data in bytes
ts	timestamp of sample in milliseconds

MediaSample() [2/7]

r5::common::MediaSample::MediaSample ( MediaDesc  mediaType, uint8_t *  data, uint32_t  dataSize, uint32_t  ts  )

inline

Initializing constructor Will set values, allocate and initialize internal buffer based on parameters.

Parameters

mediaType	media description of sample data
data	pointer to data array that will be copied into internal buffer
dataSize	size of sample data in bytes
ts	timestamp of sample in milliseconds

MediaSample() [3/7]

r5::common::MediaSample::MediaSample ( MediaDesc  mediaType, char *  data, uint32_t  dataSize, uint32_t  ts  )

inline

Initializing constructor (char variant) Will set values, allocate and initialize internal buffer based on parameters.

Parameters

mediaType	media description of sample data
data	pointer to data array that will be copied into internal buffer
dataSize	size of sample data in bytes
ts	timestamp of sample in milliseconds

MediaSample() [4/7]

r5::common::MediaSample::MediaSample ( MediaDesc  mediaType, std::unique_ptr< uint8_t[]>  data, uint32_t  dataSize, uint32_t  ts  )

inline

Initializing constructor Will set values, allocate and initialize internal buffer based on parameters Note: data pointer will be moved to internal buffer, so it will be no longer valid.

Parameters

mediaType	media description of sample data
data	unique pointer to data array that will be copied into internal buffer
dataSize	size of sample data in bytes
ts	timestamp of sample in milliseconds

MediaSample() [5/7]

r5::common::MediaSample::MediaSample ( MediaDesc  mediaType, std::unique_ptr< char[]>  data, uint32_t  dataSize, uint32_t  ts  )

inline

Initializing constructor (char variant) Will set values, allocate and initialize internal buffer based on parameters Note: data pointer will be moved to internal buffer, so it will be no longer valid.

Parameters

mediaType	media description of sample data
data	unique pointer to data array that will be copied into internal buffer
dataSize	size of sample data in bytes
ts	timestamp of sample in milliseconds

MediaSample() [6/7]

r5::common::MediaSample::MediaSample ( MediaSample &  other )

inline

Copying constructor.

Parameters

other

original object to copy

MediaSample() [7/7]

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

inline

Copying constructor.

Parameters

other

original object to copy

Member Function Documentation

operator=() [1/2]

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

inline

Assign MediaSample value.

Parameters

other

original object to copy

Returns

*this

operator=() [2/2]

MediaSample& r5::common::MediaSample::operator= ( const MediaSample &  other )

inline

Assign MediaSample 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