CascadeMPEGPlayerMessage Class Reference

a class for playing Media files More...

#include <cascade/av/CascadeMPEGPlayerMessage.h>

List of all members.

Public Types
typedef Error	EndReason
enum	Type {   kOpenSession = 0, kCloseSession = 1, kQueueFile = 2, kPause = 3,   kResume = 4, kOnSessionAbort = 100, kOnPlaybackBegin = 101, kOnPlaybackEnd = 102,   kOnPlaybackLoop = 103 }
enum	Error {   kEndOfFile = 0, kFileNotFound = 1, kFileReadError = 2, kBadFormat = 3,   kDecoderError = 4 }
Static Public Member Functions
static u32	MessageID ()
static const char *	WormholeURL ()
Public Attributes
Type	m_type
u32	m_nSessionID
u32	m_nFileRef
u32	m_nPlayCount
int	m_nPID
u8	m_nPriority
bool	m_bResult
Error	m_error
u32	m_nSerializedMPEGFileDataLen
u8	m_serializedMPEGFileData [4096]

---

Detailed Description

a class for playing Media files

Skip the description

CascadeMPEGPlayerMessage is a class that allows easy playback of Media files

---

class CascadeMPEGPlayerMessage

---

Member Typedef Documentation

typedef Error CascadeMPEGPlayerMessage::EndReason

---

Member Enumeration Documentation

enum CascadeMPEGPlayerMessage::Error

Enumeration values: kEndOfFile  kFileNotFound  kFileReadError  kBadFormat  kDecoderError

enum CascadeMPEGPlayerMessage::Type

represents the message type CascadeMPEGPlayerMessage contain a member variables of this type indicating the type of the message See also: m_type Enumeration values: kOpenSession  open session command kCloseSession  close session command kQueueFile  queue file command kPause  pause command kResume  resume command kOnSessionAbort  session abort notification kOnPlaybackBegin  playback begin notification kOnPlaybackEnd  playback end notification kOnPlaybackLoop  playback loop notification

---

Member Function Documentation

static u32 CascadeMPEGPlayerMessage::MessageID (   )  [static]

returns the messageID of the CascadeMPEGPlayerMessage MessageID() is used to determine if a wormhole message is a CascadeMPEGPlayerMessage Use it as follows: CascadeMessage * pMessage = wormhole.WaitForMessage(); if ((NULL != pMessage) && (pMessage->ID() == CascadeMPEGPlayerMessage::MessageID())) { // we have an mpeg player message } Returns: the messageID of the CascadeMPEGPlayerMessage

static const char* CascadeMPEGPlayerMessage::WormholeURL (   )  [static]

returns the wormhole URL of the Cascade MPEG Player WormholeURL() is used to get the wormhole URL of the Cascade MPEG Player. This is a static string - do not modify it! Returns: the wormhole URL of the Cascade MPEG Player

---

Member Data Documentation

bool CascadeMPEGPlayerMessage::m_bResult

Error CascadeMPEGPlayerMessage::m_error

u32 CascadeMPEGPlayerMessage::m_nFileRef

int CascadeMPEGPlayerMessage::m_nPID

u32 CascadeMPEGPlayerMessage::m_nPlayCount

u8 CascadeMPEGPlayerMessage::m_nPriority

u32 CascadeMPEGPlayerMessage::m_nSerializedMPEGFileDataLen

u32 CascadeMPEGPlayerMessage::m_nSessionID

u8 CascadeMPEGPlayerMessage::m_serializedMPEGFileData[4096]

Type CascadeMPEGPlayerMessage::m_type

---

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

• CascadeMPEGPlayerMessage.h

---