vrs::datalayout_conventions Namespace Reference

Name and type conventions used to map ContentBlockReader needs to DataLayout data. More...

Classes
class	AudioSpec
	DataLayout definitions use to describe what's in an audio content block. More...
class	ImageSpec
	DataLayout definitions use to describe what's in an image content block. More...
class	NextContentBlockSpec
	Optional values specifying the content block following the DataLayout. More...
class	VideoFrameSpec
	DataLayout definitions use to describe a video image content block. More...

Typedefs
using	ImageSpecType = uint32_t
	Data type to use for the kImageXXX fields above.
using	ContentBlockSizeType = uint32_t

Variables
constexpr const char *	kImageWidth = "image_width"
	DataLayout convention name for the image width.
constexpr const char *	kImageHeight = "image_height"
	DataLayout convention name for the image height.
constexpr const char *	kImageStride = "image_stride"
	DataLayout convention name for the image stride for the first plane.
constexpr const char *	kImageStride2 = "image_stride_2"
	DataLayout convention name for the image stride for the other planes (not the first plane).
constexpr const char *	kImagePixelFormat = "image_pixel_format"
	DataLayout convention name for the pixel format specification (see vrs::ImageFormat).
constexpr const char *	kImageBytesPerPixel = "image_bytes_per_pixel"
constexpr const char *	kImageCodecName = "image_codec_name"
	DataLayout convention name for video codec name.
constexpr const char *	kImageCodecQuality = "image_codec_quality"
	DataLayout convention video codec quality setting.
constexpr const char *	kImageKeyFrameTimeStamp = "image_key_frame_timestamp"
	DataLayout convention name for the stream's most recent video keyframe timestamp.
constexpr const char *	kImageKeyFrameIndex = "image_key_frame_index"
constexpr const char *	kAudioFormat = "audio_format"
	DataLayout convention name for the audio format (see vrs::AudioFormat).
constexpr const char *	kAudioSampleFormat = "audio_sample_format"
	DataLayout convention name for the audio sample format (see vrs::AudioSampleFormat).
constexpr const char *	kAudioSampleFrameStride = "audio_sample_stride"
constexpr const char *	kAudioChannelCount = "audio_channel_count"
	DataLayout convention name for the audio channel count: mono = 1, stereo = 2, etc.
constexpr const char *	kAudioSampleRate = "audio_sample_rate"
	DataLayout convention name for the sample rate (samples per seconde).
constexpr const char *	kAudioSampleCount = "audio_sample_count"
	DataLayout convention name for a count of audio sample frames.
constexpr const char *	kAudioStereoPairCount = "audio_stereo_pair_count"
	DataLayout convention name for a count of audio coupled stream count.
constexpr const char *	kNextContentBlockSize = "next_content_block_size"
	DataLayout convention to specify the size of the content block following.

Detailed Description

Name and type conventions used to map ContentBlockReader needs to DataLayout data.

Variable Documentation

kAudioSampleFrameStride

constexpr const char* vrs::datalayout_conventions::kAudioSampleFrameStride = "audio_sample_stride"

constexpr

DataLayout convention name for the padded number of bytes per sample frame. A sample frame is made of kAudioChannelCount synchronous audio channel samples.

kImageBytesPerPixel

constexpr const char* vrs::datalayout_conventions::kImageBytesPerPixel = "image_bytes_per_pixel"

constexpr

DataLayout convention name for the number of bytes per pixel, deprecated. Deprecated because less specific than kImagePixelFormat, which you should use instead.

kImageKeyFrameIndex

constexpr const char* vrs::datalayout_conventions::kImageKeyFrameIndex = "image_key_frame_index"

constexpr

DataLayout convention name for video key frame index since the last key frame. 0 = this frame is a key frame, 1 = the previous frame was the last seen key frame, etc...