SaturnRingLibrary 0.9.1
SGL wrapper
 
Loading...
Searching...
No Matches
SRL::CinepakPlayer Class Referencefinal

Detailed Description

Cinepak movie player.

Note
Available only if SGL sound driver is enabled (set SRL_USE_SGL_SOUND_DRIVER to 1 in makefile)

#include <srl_cinepak.hpp>

Classes

struct  MovieDecodeParams
 Parameters to specify movie playback decoding. More...
 

Public Types

enum class  ColorDepth { RGB15 = 0 , RGB24 = 1 }
 Playback color depth. More...
 
enum class  PlaybackStateEnum {
  Error = -1 , Stop = 0 , Paused = 1 , Started = 2 ,
  HeaderProcessing = 3 , Timer = 4 , Completed = 5
}
 Playback status. More...
 

Public Member Functions

 CinepakPlayer ()
 Construct a new Cinepak Player instance.
 
 ~CinepakPlayer ()
 Destroy the Cinepak Player instance.
 
ColorDepth GetDepth () const
 Get movie color depth.
 
void * GetFrameData () const
 Get decoded frame data.
 
SRL::Types::Resolution GetResolution () const
 Get movie resolution.
 
PlaybackStateEnum GetStatus () const
 Get movie playback status.
 
SRL::Math::Fxp GetTime () const
 Get current playback time.
 
bool LoadMovie (const char *file, const MovieDecodeParams decodeParams=MovieDecodeParams())
 Load movie to play.
 
void Pause () const
 Pause movie playback.
 
void Play ()
 Start movie playback.
 
void SetAudioPan (const uint8_t pan) const
 Set left/right audio panning.
 
void SetSpeed (const int32_t rate, const bool outputAudio=true) const
 Set movie playback speed.
 
void SetVolume (const uint32_t volume) const
 Set Movie playback volume.
 
void Stop ()
 Stop movie playback.
 
void UnloadMovie ()
 Unload movie file.
 

Public Attributes

SRL::Types::Event< CinepakPlayer & > OnCompleted
 Movie playback was completed.
 
SRL::Types::Event< CinepakPlayer & > OnFrame
 Movie frame was decoded.
 

Static Public Attributes

static SRL::Types::Event< int32_t > OnError
 Global error handler event.