ttv::broadcast::VideoFrame Class Reference

#include <videoframe.h>

Public Types
typedef std::function< void()>	UnlockFunc

Public Member Functions
virtual	~VideoFrame ()
void	SetTimeStamp (uint64_t timeStamp)
uint64_t	GetTimeStamp () const
void	SetIsKeyFrame (bool isKeyFrame)
bool	IsKeyFrame () const
void	SetVerticalFlip (bool flip)
bool	GetVerticalFlip () const
void	SetFrameIndex (uint32_t frameIndex)
uint32_t	GetFrameIndex () const
IVideoFrameReceiver::ReceiverTypeId	GetReceiverTypeId () const

Protected Member Functions
	VideoFrame (IVideoFrameReceiver::ReceiverTypeId receiverTypeId)
void	SetUnlockCallback (UnlockFunc callback)

Private Attributes
UnlockFunc	mUnlockCallback
IVideoFrameReceiver::ReceiverTypeId	mReceiverTypeId
uint64_t	mTimeStamp
uint32_t	mFrameIndex
bool	mIsKeyFrame
bool	mVerticalFlip

Detailed Description

The container for video data to be encoded. This class will be extended to hold implementation-specific data.

Member Typedef Documentation

UnlockFunc

typedef std::function<void()> ttv::broadcast::VideoFrame::UnlockFunc

Constructor & Destructor Documentation

~VideoFrame()

virtual ttv::broadcast::VideoFrame::~VideoFrame ( )

virtual

VideoFrame()

ttv::broadcast::VideoFrame::VideoFrame ( IVideoFrameReceiver::ReceiverTypeId  receiverTypeId )

protected

Member Function Documentation

GetFrameIndex()

uint32_t ttv::broadcast::VideoFrame::GetFrameIndex ( ) const

inline

GetReceiverTypeId()

IVideoFrameReceiver::ReceiverTypeId ttv::broadcast::VideoFrame::GetReceiverTypeId ( ) const

inline

Returns the type id of the receiver that packaged the VideoFrame.

GetTimeStamp()

uint64_t ttv::broadcast::VideoFrame::GetTimeStamp ( ) const

inline

GetVerticalFlip()

bool ttv::broadcast::VideoFrame::GetVerticalFlip ( ) const

inline

IsKeyFrame()

bool ttv::broadcast::VideoFrame::IsKeyFrame ( ) const

inline

SetFrameIndex()

void ttv::broadcast::VideoFrame::SetFrameIndex ( uint32_t  frameIndex )

inline

SetIsKeyFrame()

void ttv::broadcast::VideoFrame::SetIsKeyFrame ( bool  isKeyFrame )

inline

SetTimeStamp()

void ttv::broadcast::VideoFrame::SetTimeStamp ( uint64_t  timeStamp )

inline

SetUnlockCallback()

void ttv::broadcast::VideoFrame::SetUnlockCallback ( UnlockFunc  callback )

inlineprotected

SetVerticalFlip()

void ttv::broadcast::VideoFrame::SetVerticalFlip ( bool  flip )

inline

Member Data Documentation

mFrameIndex

uint32_t ttv::broadcast::VideoFrame::mFrameIndex

private

mIsKeyFrame

bool ttv::broadcast::VideoFrame::mIsKeyFrame

private

mReceiverTypeId

IVideoFrameReceiver::ReceiverTypeId ttv::broadcast::VideoFrame::mReceiverTypeId

private

mTimeStamp

uint64_t ttv::broadcast::VideoFrame::mTimeStamp

private

mUnlockCallback

UnlockFunc ttv::broadcast::VideoFrame::mUnlockCallback

private

mVerticalFlip

bool ttv::broadcast::VideoFrame::mVerticalFlip

private

---

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

• modules/broadcast/broadcast_common/include/twitchsdk/broadcast/videoframe.h