Notifies that the player is ready to start accepting messages.
None.
Notifies that the last command message received has been successfully processed.
The message contains the code of the message that is being acknowledged.
message.ack unsigned char code of the message that is being acknowledged.
Notifies that the last command message received could not be successfully processed.
The message contains the code of the message that is being negatively acknowledged, and an error code that identifies the reason for the failure.
message.nack.command unsigned char code of the message that is being negatively acknowledged. message.nack.code short error code that tells the reason for the failure.
Notifies that the player has deleted its resources and exited.
None.
Notifies a pong tag in response to a XA_MSG_COMMAND_PING message.
The message contains the tag value of the XA_MSG_COMMAND_PING message that triggered this response.
message.tag unsigned long tag value (user-defined).
Notifies that the player's state has changed.
The value of the player's state is passed with the message.
Valid values for the state are:
XA_PLAYER_STATE_STOPPED: the player is stopped.
XA_PLAYER_STATE_PLAYING: the player is playing.
XA_PLAYER_STATE_PAUSED: the player is paused.
XA_PLAYER_STATE_EOF: the player has reached the end of the input stream (the client would typically send a message to tell to open the next input stream when it receives this).
message.state unsigned char player state value.
Notifies that the player's behavior mode.
The value of the player's mode is an OR'ed combination of mode flags.
See the documentation for the XA_MSG_SET_PLAYER_MODE message for more details.
message.mode unsigned long player mode.
Notifies the value of an integer environment variable.
message.environmemt.name const char * name of the environment variable. message.environment.value.integer long variable's integer value.
Notifies the value of a string environment variable.
message.environmemt.name const char * name of the environment variable. message.environment.value.string const char * variable's string value.
Notifies that the player's input state has changed.
The new value of the player's input state is passed with the message.
Valid values for the state are:
XA_IO_STATE_CLOSED: the input is closed.
XA_IO_STATE_OPEN: the input is open.
message.state unsigned char new state of the player's input.
Notifies of the player's current input name.
message.name char * player's input name.
Notifies of the player's current input capabilities.
This is typically useful to be notified wether it is possible to seek into an input stream (an disabling a seek bar for instance, if it is not).
The flag XA_DECODER_INPUT_SEEKABLE indicates wether it is possible to seek or not.
message.caps unsigned long player's input capabilities.
Notifies that the player's input position has changed.
message.position.offset unsigned long current number of position 'steps' elapsed from the start of the stream. message.position.range unsigned long total number of position 'steps' in the stream.
Notifies the value of the player's input position range.
message.range unsigned long player's input position range.
Notifies that the player's input timecode has changed.
message.timecode.h unsigned char number of hours. message.timecode.m unsigned char number of minutes. message.timecode.s unsigned char number of seconds. message.timecode.f unsigned char number of fractions (100 fractions per second).
Notifies the value of the player's input timecode granularity.
message.granularity unsigned long timecode granularity.
Notifies the duration of the current input stream.
message.duration unsigned long duration in seconds.
Notifies information about the current input stream.
message.stream_info.level unsigned char MPEG level (1 for MPEG 1, 2 for MPEG 2, 0 for MPEG 2.5). message.stream_info.layer unsigned char MPEG layer (1, 2 or 3). message.stream_info.bitrate unsigned short bitrate in bits per second. message.stream_info.frequency unsigned short sampling frequency in Hz. message.stream_info.mode unsigned char MPEG mode (0 for stereo, 1 for joint-stereo, 2 for dual-channel, 3 for mono).
Notifies of the player's current input module ID.
message.module_id short player's input module ID.
Notifies information about an input module.
message.module_info.id unsigned char ID of the module. message.module_info.nb_devices unsigned char number of devices handled by this module. message.module_info.name const char * name of the module. message.module_info.description const char * description of the module.
Notifies information about an input device of an input module.
message.device_info.module_id unsigned char ID of the module this device belongs to. message.device_info.index unsigned char index of this device within a module (first is 0). message.device_info.flags unsigned char device flags. message.device_info.name const char * device name. message.device_info.description const char * device description.
Notifies information about an input filter.
message.filter_info.name const char * filter name. message.filter_info.id short ID of the filter.
Notifies that the player's output state has changed.
The new value of the player's output state is passed with the message.
Valid values for the state are:
XA_IO_STATE_CLOSED: the output is closed.
XA_IO_STATE_OPEN: the output is open.
message.state unsigned char new state of the player's output.
Notifies of the player's current output name.
message.name char * player's output name.
Notifies of the player's current output capabilities.
message.caps unsigned long player's output capabilities.
Notifies of the player's current output volume.
message.volume.master_level unsigned char player's output volume master level. message.volume.pcm_level unsigned char player's output volume PCM level. message.volume.balance unsigned char player's output balance.
Notifies of the player's current output balance.
message.volume.balance unsigned char player's output balance.
Notifies of the player's current output PCM level.
message.volume.pcm_level unsigned char player's output PCM level.
Notifies of the player's current output master level.
message.volume.master_level unsigned char player's output master level.
Notifies of the player's current output channels configuration.
message.channels unsigned char player's output channels configuration.
Notifies of the player's current output ports configuration.
message.ports unsigned long player's output ports configuration.
Notifies of the player's current output module ID.
message.module_id short player's output module ID.
Notifies information about an output module.
message.module_info.id unsigned char ID of the module. message.module_info.nb_devices unsigned char number of devices handled by this module. message.module_info.name const char * name of the module. message.module_info.description const char * description of the module.
Notifies information about an output device of an output module.
message.device_info.module_id unsigned char ID of the module this device belongs to. message.device_info.index unsigned char index of this device within a module (first is 0). message.device_info.flags unsigned char device flags. message.device_info.name const char * device name. message.device_info.description const char * device description.
Notifies information about an output filter.
message.filter_info.name const char * filter name. message.filter_info.id short ID of the filter.
Notifies of the player's current codec equalizer values.
message.equalizer_info XA_EqualizerInfo * pointer to a codec equalizer info structure, or NULL if the equalizer has been disabled.
Notifies of the current notification mask.
message.notification_mask unsigned long current notification mask.
Notifies of 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...).
message.progress_info.source unsigned char ID of the module that sent the message. message.progress.code unsigned char progress code (user-defined). message.progress.value short a progress value. message.progress.message const char * a user-defined string that gives textual information about the progress message.
Notifies of an error message.
message.error.source unsigned char ID of the module that sent the message. message.error.code short error code. message.error.message const char * a user-defined string that gives textual information about the error.
Notifies of a debug message.
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 client application.
message.debug.source unsigned char ID of the module that sent the message. message.debug.level unsigned char debug level. message.debug.message const char * a user-defined string that gives textual debug information.