OpenNI 1.3.2
Public Member Functions | List of all members
xn::Player Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Player:
Inheritance graph

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)
 
- Public Member Functions inherited from xn::ProductionNode
 ProductionNode (XnNodeHandle hNode=NULL)
 
 ProductionNode (const NodeWrapper &other)
 
NodeInfo GetInfo () const
 
XnStatus AddNeededNode (ProductionNode &needed)
 
XnStatus RemoveNeededNode (ProductionNode &needed)
 
XnBool IsCapabilitySupported (const XnChar *strCapabilityName) const
 
XnStatus SetIntProperty (const XnChar *strName, XnUInt64 nValue)
 
XnStatus SetRealProperty (const XnChar *strName, XnDouble dValue)
 
XnStatus SetStringProperty (const XnChar *strName, const XnChar *strValue)
 
XnStatus SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
 
XnStatus GetIntProperty (const XnChar *strName, XnUInt64 &nValue) const
 
XnStatus GetRealProperty (const XnChar *strName, XnDouble &dValue) const
 
XnStatus GetStringProperty (const XnChar *strName, XnChar *csValue, XnUInt32 nBufSize) const
 
XnStatus GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
 
XnStatus LockForChanges (XnLockHandle *phLock)
 
void UnlockForChanges (XnLockHandle hLock)
 
XnStatus LockedNodeStartChanges (XnLockHandle hLock)
 
void LockedNodeEndChanges (XnLockHandle hLock)
 
const ErrorStateCapability GetErrorStateCap () const
 
ErrorStateCapability GetErrorStateCap ()
 
GeneralIntCapability GetGeneralIntCap (const XnChar *strCapability)
 
void GetContext (Context &context) const
 
- Public Member Functions inherited from xn::NodeWrapper
 NodeWrapper (XnNodeHandle hNode)
 
 NodeWrapper (const NodeWrapper &other)
 
NodeWrapperoperator= (const NodeWrapper &other)
 
 ~NodeWrapper ()
 
 operator XnNodeHandle () const
 
XnNodeHandle GetHandle () const
 
XnBool operator== (const NodeWrapper &other)
 
XnBool operator!= (const NodeWrapper &other)
 
XnBool IsValid () const
 
const XnChar * GetName () const
 
XnStatus AddRef ()
 
void Release ()
 
XnStatus Ref ()
 
void Unref ()
 
void SetHandle (XnNodeHandle hNode)
 
void TakeOwnership (XnNodeHandle hNode)
 

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.

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

Retrieves a list of the nodes played by a player.

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

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

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

Gets the playback speed. see xnSetPlaybackSpeed() for more details.

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.

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

Gets the name of the format supported by a player.

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

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

XnStatus xn::Player::ReadNext ( )
inline

Reads the next data element from the player.

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

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

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.

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.

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.

XnStatus xn::Player::SetRepeat ( XnBool  bRepeat)
inline

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

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.

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

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

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.

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

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


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