xn::Player Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Player:

List of all members.

Public Member Functions
XnStatus	EnumerateNodes (NodeInfoList &list)
XnStatus	GetNumFrames (const XnChar *strNodeName, XnUInt32 &nFrames)
XnStatus	GetSource (XnRecordMedium &sourceType, XnChar *strSource, XnUInt32 nBufSize)
const XnChar *	GetSupportedFormat ()
XnBool	IsEOF ()
	Player (XnNodeHandle hNode=NULL)
XnStatus	ReadNext ()
XnStatus	RegisterToEndOfFileReached (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	SeekToFrame (const XnChar *strNodeName, XnInt32 nFrameOffset, XnPlayerSeekOrigin origin)
XnStatus	SeekToTimeStamp (XnInt64 nTimeOffset, XnPlayerSeekOrigin origin)
XnStatus	SetRepeat (XnBool bRepeat)
XnStatus	SetSource (XnRecordMedium sourceType, const XnChar *strSource)
XnStatus	TellFrame (const XnChar *strNodeName, XnUInt32 &nFrame)
XnStatus	TellTimestamp (XnUInt64 &nTimestamp)
void	UnregisterFromEndOfFileReached (XnCallbackHandle hCallback)
XnStatus	Create (Context &context, const XnChar *strFormatName)

---

Detailed Description

Represents a Player node

Definition at line 2094 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::Player::Player

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Player node handle

Definition at line 2102 of file XnCppWrapper.h.

---

Member Function Documentation

XnStatus xn::Player::Create	(	Context &	context,
		const XnChar *	strFormatName
	)		[inline]

Creates a player.

For full details and usage, see xnCreatePlayer

Definition at line 4557 of file XnCppWrapper.h.

XnStatus xn::Player::EnumerateNodes

(

NodeInfoList &

list

)

[inline]

Retrieves a list of the nodes played by a player.

For full details and usage, see xnEnumeratePlayerNodes

Definition at line 2192 of file XnCppWrapper.h.

XnStatus xn::Player::GetNumFrames	(	const XnChar *	strNodeName,
		XnUInt32 &	nFrames
	)		[inline]

Retrieves the number of frames of a specific node played by a player.

For full details and usage, see xnGetPlayerNumFrames

Definition at line 2176 of file XnCppWrapper.h.

XnStatus xn::Player::GetSource	(	XnRecordMedium &	sourceType,
		XnChar *	strSource,
		XnUInt32	nBufSize
	)		[inline]

Gets the player's source, i.e where the played events come from.

For full details and usage, see xnGetPlayerSource

Definition at line 2128 of file XnCppWrapper.h.

const XnChar* xn::Player::GetSupportedFormat

(

)

[inline]

Gets the name of the format supported by a player.

For full details and usage, see xnGetPlayerSupportedFormat

Definition at line 2184 of file XnCppWrapper.h.

XnBool xn::Player::IsEOF

(

)

[inline]

Checks whether the player is at the end-of-file marker.

For full details and usage, see xnIsPlayerAtEOF

Definition at line 2206 of file XnCppWrapper.h.

XnStatus xn::Player::ReadNext

(

)

[inline]

Reads the next data element from the player.

For full details and usage, see xnPlayerReadNext

Definition at line 2136 of file XnCppWrapper.h.

XnStatus xn::Player::RegisterToEndOfFileReached	(	StateChangedHandler	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)		[inline]

Registers a callback function to be called when end-of-file is reached.

For full details and usage, see xnRegisterToEndOfFileReached

Definition at line 2214 of file XnCppWrapper.h.

XnStatus xn::Player::SeekToFrame	(	const XnChar *	strNodeName,
		XnInt32	nFrameOffset,
		XnPlayerSeekOrigin	origin
	)		[inline]

Seeks the player to a specific frame of a specific played node, so that playing will continue from that frame onwards.

For full details and usage, see xnSeekPlayerToFrame

Definition at line 2152 of file XnCppWrapper.h.

XnStatus xn::Player::SeekToTimeStamp	(	XnInt64	nTimeOffset,
		XnPlayerSeekOrigin	origin
	)		[inline]

Seeks the player to a specific timestamp, so that playing will continue from that point onwards.

For full details and usage, see xnSeekPlayerToTimeStamp

Definition at line 2144 of file XnCppWrapper.h.

XnStatus xn::Player::SetRepeat

(

XnBool

bRepeat

)

[inline]

Determines whether the player will automatically rewind to the beginning of the recording when reaching the end.

For full details and usage, see xnSetPlayerRepeat

Definition at line 2112 of file XnCppWrapper.h.

XnStatus xn::Player::SetSource	(	XnRecordMedium	sourceType,
		const XnChar *	strSource
	)		[inline]

Sets the source for the player, i.e. where the played events will come from.

For full details and usage, see xnSetPlayerSource

Definition at line 2120 of file XnCppWrapper.h.

XnStatus xn::Player::TellFrame	(	const XnChar *	strNodeName,
		XnUInt32 &	nFrame
	)		[inline]

Reports the current frame number of a specific node played by a player.

For full details and usage, see xnTellPlayerFrame

Definition at line 2168 of file XnCppWrapper.h.

XnStatus xn::Player::TellTimestamp

(

XnUInt64 &

nTimestamp

)

[inline]

Reports the current timestamp of a player, i.e. the amount of time passed since the beginning of the recording.

For full details and usage, see xnTellPlayerTimestamp

Definition at line 2160 of file XnCppWrapper.h.

void xn::Player::UnregisterFromEndOfFileReached

(

XnCallbackHandle

hCallback

)

[inline]

Unregisters a callback function which was registered using xnRegisterToEndOfFileReached().

For full details and usage, see xnUnregisterFromEndOfFileReached

Definition at line 2222 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h