OWLNext 6.32
Public Member Functions | Static Public Member Functions
owl::TMci Class Reference

TMci is a Windows MCI (Media Control Interface) encapsulation class. More...

#include <mci.h>

Inheritance diagram for owl::TMci:
owl::TMciWaveAudio

List of all members.

Public Member Functions

 TMci ()
virtual ~TMci ()
uint32 Open (MCI_OPEN_PARMS, uint32 command=0)
uint32 Close ()
uint32 Play (MCI_PLAY_PARMS, uint32 flags=0)
uint32 Stop (uint32 flags=0)
uint32 Pause (uint32 flags=0)
uint32 Resume (uint32 flags=0)
uint32 Seek (MCI_SEEK_PARMS, uint32 flags=0)
uint32 Seek (uint32 to, uint32 flags=0)
uint32 Load (const tstring &fileName, uint32 flags=0)
virtual TResult MciNotify (TParam1, TParam2)
bool IsBusy () const
void SetBusy (bool)
uint32 SendCommand (uint msg, uint32 command, uint32 param)
uint GetDeviceId () const
uint32 GetCallback () const

Static Public Member Functions

static uint32 SendCommand (uint deviceId, uint msg, uint32 command, uint32 param)

Detailed Description

TMci is a Windows MCI (Media Control Interface) encapsulation class.


Constructor & Destructor Documentation

owl::TMci::TMci ( )

Creates a hidden window for catching messages.

References owl::TWindow::Create().

owl::TMci::~TMci ( ) [virtual]

If the MCI device is still open, this closes it now. Deletes the hidden window.

References Close().


Member Function Documentation

uint32 owl::TMci::Close ( )

Stops the MCI device and closes it.

References SendCommand(), SetBusy(), and Stop().

uint32 owl::TMci::GetCallback ( ) const

Returns the callback. If the window exists, the handle of the window is returned.

uint owl::TMci::GetDeviceId ( ) const [inline]

Returns the ID of the open MCI device.

bool owl::TMci::IsBusy ( ) const [inline]

Returns true if the MCI is currently busy doing something.

uint32 owl::TMci::Load ( const tstring &  fileName,
uint32  flags = 0 
)

Loads the file into the MCI device.

References GetCallback(), and SendCommand().

TResult owl::TMci::MciNotify ( TParam1  ,
TParam2   
) [virtual]

The default MciNotify is to return 0.

uint32 owl::TMci::Open ( MCI_OPEN_PARMS  parms,
uint32  command = 0 
)

Opens the MCI device.

References SendCommand().

uint32 owl::TMci::Pause ( uint32  flags = 0)

Pauses the MCI device.

References GetCallback(), SendCommand(), and SetBusy().

uint32 owl::TMci::Play ( MCI_PLAY_PARMS  parms,
uint32  flags = 0 
)

Plays the MCI device.

References SendCommand().

uint32 owl::TMci::Resume ( uint32  flags = 0)

Resumes playing of the MCI device.

References GetCallback(), SendCommand(), and SetBusy().

uint32 owl::TMci::Seek ( uint32  to,
uint32  flags = 0 
)

Seeks a particular position on the MCI device. This function is provided for convenience.

References GetCallback(), and Seek().

uint32 owl::TMci::Seek ( MCI_SEEK_PARMS  parms,
uint32  flags = 0 
)

Seeks a particular position on the MCI device. This function requires the parameters to be specified in a structure.

References SendCommand().

uint32 owl::TMci::SendCommand ( uint  msg,
uint32  command,
uint32  param 
)

Sends the MCI command to the device if it's not busy.

References GetDeviceId(), and IsBusy().

uint32 owl::TMci::SendCommand ( uint  deviceId,
uint  msg,
uint32  command,
uint32  param 
) [static]

Sends the MCI command to the opened device.

void owl::TMci::SetBusy ( bool  b) [inline]

Sets the busy flag for the MCI device.

uint32 owl::TMci::Stop ( uint32  flags = 0)

Stops the MCI device.

References GetCallback(), SendCommand(), and SetBusy().


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