Ready Function

event tables {{AFX_EVENT(CMp3PCtrl)

This event is fired after the control has finished loading

Protected void FireReady()

Return Description
  void  


Ack Function

An acknowledgement event which is fired to acknowledge a method invocation

Protected void FireAck()

Return Description
  void  


Nack Function

A negative acknowledgement - the last command could not be processed
An error code is returned

Protected void FireNack(short )

Type Name Description
  short ErrCode  
       
Return Description
  void  


State Function

Fires on a state change. Possible values:
Stopped - 0
Playing - 1
Paused - 2
EOF (end of input stream) - 3

Protected void FireState(short )

Type Name Description
  short state  
       
Return Description
  void  


Mode Function

Fires when GetPlayerMode is called
The value of the player's mode is an OR'ed combination of mode flags.
See the documentation of the "Mode" method for more details

Protected void FireMode(long )

Type Name Description
  long mode  
       
Return Description
  void  


InputState Function

Fires on an input state change (e.g. when a file is opened).
The new value of the player's input state is passed with the message.
Valid values for the state are:
Open - 0
Closed - 1

Protected void FireInputState(short )

Type Name Description
  short state  
       
Return Description
  void  


InputPos Function

Fires when the input position has changed.

Protected void FireInputPos(long , long )

Type Name Description
  long position  
  long range  
       
Return Description
  void  


InputTimecode Function

Fires when the input timecode has changed.

Protected void FireInputTimecode(short , short , short , short )

Type Name Description
  short hour  
  short min  
  short sec  
  short frac  
       
Return Description
  void  


OutputState Function

Fires on an output state change (e.g. a file begins to play)
The new value of the player's output state is passed with the message.
Valid values for the state are:
Open - 0
Closed - 1

Protected void FireOutputState(short )

Type Name Description
  short state  
       
Return Description
  void  


Volume Function

Fires to inform of the current volume

Protected void FireVolume(short , short , short )

Type Name Description
  short master  
  short pcm  
  short balance  
       
Return Description
  void  


Balance Function

Fires when an output is set and when GetMasterVolume is called

Protected void FireBalance(short )

Type Name Description
  short balance  
       
Return Description
  void  


Debug Function

Debug messages are used by the decoder and the different input and output modules and filters to send back debug information that can be displayed by the application

Protected void FireDebug(short , LPCTSTR )

Type Name Description
  short level  
  LPCTSTR info  
       
Return Description
  void  


XError Function

Protected void FireXError(short , LPCTSTR )

Type Name Description
  short code  
  LPCTSTR info  
       
Return Description
  void  


InputDuration Function

Contains the duration of the current input stream

Protected void FireInputDuration(long )

Type Name Description
  long duration  
       
Return Description
  void  


Pong Function

This event is fired in response to the "Ping" method being called

Protected void FirePong(long )

Type Name Description
  long tag  
       
Return Description
  void  


Exited Function

Fires when the control is exited

Protected void FireExited()

Return Description
  void  


PlayerEnvironmentInteger Function

Contains the value of a integer environment variable

Protected void FirePlayerEnvironmentInteger(LPCTSTR , long )

Type Name Description
  LPCTSTR name  
  long aInteger  
       
Return Description
  void  


PlayerEnvironmentString Function

Contains the value of an string environment variable

Protected void FirePlayerEnvironmentString(LPCTSTR , LPCTSTR )

Type Name Description
  LPCTSTR name  
  LPCTSTR aString  
       
Return Description
  void  


InputName Function

Fires when the input name is set or GetInputName is called

Protected void FireInputName(LPCTSTR )

Type Name Description
  LPCTSTR name  
       
Return Description
  void  


InputCaps Function

Contains the players current input capabilities

Protected void FireInputCaps(long )

Type Name Description
  long caps  
       
Return Description
  void  


InputPostionRange Function

Fires when GetPositionRange and GetPositionPercentage is called

Protected void FireInputPositionRange(long )

Type Name Description
  long range  
       
Return Description
  void  


InputTimecodeGranularity Function

Containts the current input timecode granularity value

Protected void FireInputTimecodeGranularity(long )

Type Name Description
  long granularity  
       
Return Description
  void  


InputStreamInfo Function

Contains information about the current input stream:
MPEG level (1 for MPEG 1, 2 for MPEG 2, 0 for MPEG 2.5)
MPEG layer (1, 2 or 3)
bitrate in bits per second
sampling frequency in Hz
MPEG mode (0 for stereo, 1 for joint-stereo, 2 for dual-channel, 3 for mono)

Protected void FireInputStreamInfo(short , short , short , short , short )

Type Name Description
  short MPEGLevel  
  short MPEGLayer  
  short bitrate  
  short samplingFreq  
  short MPEGmode  
       
Return Description
  void  


InputModule Function

Fires on GetInputModuleName call, contains the current input module ID

Protected void FireInputModule(short )

Type Name Description
  short id  
       
Return Description
  void  


InputModuleInfo Function

Contains information about an input module:
ID of the module
number of devices handled by this module
name of the module
description of the module

Protected void FireInputModuleInfo(short , short , LPCTSTR , LPCTSTR )

Type Name Description
  short id  
  short nrDevices  
  LPCTSTR name  
  LPCTSTR description  
       
Return Description
  void  


InputDeviceInfo Function

Contains information about an input device of an input module:
ID of the module this device belongs to
index of this device within a module (first is 0).
device flags
device name
device description

Protected void FireInputDeviceInfo(short , short , short , LPCTSTR , LPCTSTR )

Type Name Description
  short id  
  short index  
  short flags  
  LPCTSTR name  
  LPCTSTR description  
       
Return Description
  void  


InputFilterInfo Function

Contains information about an input filter
filter name
id of the filter

Protected void FireInputFilterInfo(LPCTSTR , short )

Type Name Description
  LPCTSTR name  
  short id  
       
Return Description
  void  


OutputName Function

Fires when the output name is set or GetOutputName is called

Protected void FireOutputName(LPCTSTR )

Type Name Description
  LPCTSTR name  
       
Return Description
  void  


OutputCaps Function

Contains the current output capabilities

Protected void FireOutputCaps(long )

Type Name Description
  long caps  
       
Return Description
  void  


PCMLevel Function

Fires when an output is set and when GetMasterVolume is called

Protected void FirePCMLevel(short )

Type Name Description
  short level  
       
Return Description
  void  


MasterLevel Function

Fires when an output is set and when GetMasterVolume is called

Protected void FireMasterLevel(short )

Type Name Description
  short level  
       
Return Description
  void  


OutputChannels Function

Contains the current output channels configuration

Protected void FireOutputChannels(short )

Type Name Description
  short channels  
       
Return Description
  void  


OutputPorts Function

Contains the current output ports configuration

Protected void FireOutputPorts(long )

Type Name Description
  long ports  
       
Return Description
  void  


OutputModule Function

Contains the current output module ID

Protected void FireOutputModule(short )

Type Name Description
  short id  
       
Return Description
  void  


OutputModuleInfo Function

Contains information about an output module:
ID of the module
number of devices handled by this module
name of the module
description of the module

Protected void FireOutputModuleInfo(short , short , LPCTSTR , LPCTSTR )

Type Name Description
  short id  
  short nrDevices  
  LPCTSTR name  
  LPCTSTR description  
       
Return Description
  void  


OutputDeviceInfo

Contains information about an output device of an output module:
ID of the module this device belongs to
index of this device within a module (first is 0)
device flags
device name
device description

Protected void FireOutputDeviceInfo(short , short , short , LPCTSTR , LPCTSTR )

Type Name Description
  short id  
  short index  
  short flags  
  LPCTSTR name  
  LPCTSTR description  
       
Return Description
  void  


OutputFilterInfo Function

Contains information about an output filter:
filter name
ID of the filter

Protected void FireOutputFilterInfo(LPCTSTR , short )

Type Name Description
  LPCTSTR name  
  short id  
       
Return Description
  void  


NotificationMask Function

Contains the current notification mask

Protected void FireNotificationMask(long )

Type Name Description
  long mask  
       
Return Description
  void  


DebugLevel Function

Fires when GetDebugLevel is called

Protected void FireDebugLevel(short )

Type Name Description
  short level  
       
Return Description
  void  


Progress Function

A progress message (typically used by input modules like the network streaming module to notify the client of progress info like buffer fullness, network connection status, etc...)
Information includes:
ID of the module that sent the message
progress code (user-defined)
a progress value
a user-defined string that gives textual information about the progress message

Protected void FireProgress(short , short , short , LPCTSTR )

Type Name Description
  short id  
  short code  
  short progress  
  LPCTSTR message  
       
Return Description
  void