CascadeMPEGPlayer.h

Go to the documentation of this file.

//
// CascadeMPEGPlayer.h - header file for class CascadeMPEGPlayer
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEMPEGPLAYER_H
#define _ROKU_INCLUDE_CASCADE_AV_CASCADEMPEGPLAYER_H

#include <cascade/app/CascadeAppMessageSink.h>
#include <cascade/av/CascadeMPEGPlayerMessage.h>
#include <cascade/av/CascadeMPEGFile.h>


class CascadeMPEGPlayer : public CascadeAppMessageSink
{
public:
        CascadeMPEGPlayer();
        virtual ~CascadeMPEGPlayer();
public:
    virtual bool OpenSession(u8 nPriority);
        // Call OpenSession() to open an mpeg playback session.
        //
        // nPriority is the priority of the session.
        // Only one session system-wide can be opened at a time.
        // If a session of higher priority is opened, any session
        // of lower priority is automatically aborted.
        // 1 is the highest priority; 255 is the lowest priority
        // 0 is reserved.

    virtual bool CloseSession();
        // CloseSession() closes a previously opened session.

    virtual u32 QueueFile(CascadeMPEGFile & mpegFile, u32 nPlayCount);
        // QueueFile() queues a file for playback which will play nPlayCount
        // times before stopping.  if nPlayCount is zero, the file will loop
        // indefinitely or until another file is queued (see below).
        //
        // NOTE: As soon as another file is queued it starts playing
        // whenever this file has reached its end (i.e. nPlayCount is treated
        // as if it is 1 whenever a subsequent file is queued).
        //
        // QueueFile() returns a file reference number which is used
        // in file status virtual member functions below

    virtual bool Pause();
        // Pause() pauses playback of the currently playing file.

    virtual bool Resume();
        // Resume() resumes playback of the currently playing file.

protected:
    typedef CascadeMPEGPlayerMessage::EndReason EndReason;

    virtual void OnSessionAbort();
        // OnSessionAbort() is called if your open session has been aborted
        // because someone else has opened a higher priority session.

    virtual void OnPlaybackBegin(u32 nFileRef);
        // OnPlaybackBegin() is called when playback of a previously queued file starts

    virtual void OnPlaybackEnd(u32 nFileRef, EndReason reason);
        // OnPlaybackEnd() is called when playback of a previously queued file ends (the end
        // of playback is reached)

    virtual void OnPlaybackLoop(u32 nFileRef);
        // OnPlaybackLoop() is called when playback of a previously queued file loops

protected:
    CascadeMPEGPlayerMessage * SendMessage(const CascadeMPEGPlayerMessage & message);

private:
    virtual bool OnWormholeMessage(const CascadeMessage & message);

private:
    u32 m_nSessionID;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEMPEGPLAYER_H

//  LOG
//  23-Oct-03   dwoodward       created
//  28-Oct-03   dwoodward   added EndReason, OnPlaybackLoop
//  08-Nov-03   dwoodward   QueueFile now takes a CascadeMPEGFile not a CascadeFile

---