xn::Player Class Reference
[C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::Player:
[legend]

List of all members.

Public Member Functions

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

XnStatus Create (Context &context, const XnChar *strFormatName)

Detailed Description

Represents a Player node


Constructor & Destructor Documentation

xn::Player::Player ( XnNodeHandle  hNode = NULL  )  [inline]

Ctor

Parameters:
hNode [in] Player node handle
xn::Player::Player ( const NodeWrapper other  )  [inline]

Member Function Documentation

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

Creates a player. For full details and usage, see xnCreatePlayer

XnStatus xn::Player::EnumerateNodes ( NodeInfoList list  )  const [inline]

Retrieves a list of the nodes played by a player. For full details and usage, see xnEnumeratePlayerNodes

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

Retrieves the number of frames of a specific node played by a player. For full details and usage, see xnGetPlayerNumFrames

XnDouble xn::Player::GetPlaybackSpeed (  )  const [inline]

Gets the playback speed. see xnSetPlaybackSpeed() for more details. For full details and usage, see xnGetPlaybackSpeed

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

Gets the player's source, i.e where the played events come from. For full details and usage, see xnGetPlayerSource

const XnChar* xn::Player::GetSupportedFormat (  )  const [inline]

Gets the name of the format supported by a player. For full details and usage, see xnGetPlayerSupportedFormat

XnBool xn::Player::IsEOF (  )  const [inline]

Checks whether the player is at the end-of-file marker. For full details and usage, see xnIsPlayerAtEOF

XnStatus xn::Player::ReadNext (  )  [inline]

Reads the next data element from the player. For full details and usage, see xnPlayerReadNext

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

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

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

XnStatus xn::Player::SetPlaybackSpeed ( XnDouble  dSpeed  )  [inline]

Sets the playback speed, as a ratio of the time passed in the recording. A value of 1.0 means the player will try to output frames in the rate they were recorded (according to their timestamps). A value bigger than 1.0 means fast-forward, and a value between 0.0 and 1.0 means slow-motion. The special value of XN_PLAYBACK_SPEED_FASTEST (0.0) means there will be no delay, and that frames will be returned as soon as asked for. For full details and usage, see xnSetPlaybackSpeed

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

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

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

Reports the current frame number of a specific node played by a player. For full details and usage, see xnTellPlayerFrame

XnStatus xn::Player::TellTimestamp ( XnUInt64 &  nTimestamp  )  const [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

void xn::Player::UnregisterFromEndOfFileReached ( XnCallbackHandle  hCallback  )  [inline]

Unregisters a callback function which was registered using xnRegisterToEndOfFileReached(). For full details and usage, see xnUnregisterFromEndOfFileReached


The documentation for this class was generated from the following file:
Generated on Fri Nov 9 22:59:09 2012 for OpenNI 1.3.2 by  doxygen 1.6.3