---

PlayState object

Typedefs
typedef _XLV_PlayState	XLV_PlayState
	XLV_PlayState object short definition.
Functions
XLV_PlayState *	xlv_open_url_play (XLV_Session *session, const gchar *name)
	an XLV_PlayState constructor. More...
XLV_PlayState *	xlv_open_play (XLV_Session *session, const gchar *name)
	an XLV_PlayState constructor. More...
XLV_PlayState *	xlv_open_play_stream (XLV_Session *session, XLV_Stream *stream)
	an XLV_PlayState constructor. More...
void	xlv_close_play (XLV_PlayState *state)
	XLV_PlayState destructor. More...
void	xlv_set_video_stream (XLV_PlayState *state, guint stream_no)
	This changes the current video stream used to build the output image. More...
void	xlv_set_audio_stream (XLV_PlayState *state, guint stream_no)
	This changes the current video stream used to build the output sound stream. More...
void	xlv_setup_video_codec (XLV_PlayState *state)
	Prepare video codec.
void	xlv_setup_audio_codec (XLV_PlayState *state)
	Prepare audio codec.
void	xlv_setup_video_output (XLV_PlayState *state, XLV_Stream *video_output)
	Specifies which video renderer we must use for the video output. More...
void	xlv_setup_audio_output (XLV_PlayState *state, XLV_Stream *audio_output)
	Specifies which audio renderer we must use for the audio output. More...
XLV_Stream *	xlv_play_get_video_renderer (XLV_PlayState *state)
	Returns the current video renderer. More...
XLV_Stream *	xlv_play_get_audio_renderer (XLV_PlayState *state)
	Returns the current audio renderer. More...
XLV_Stream *	xlv_play_get_audio_codec (XLV_PlayState *state)
	Returns the selected audio codec. More...
XLV_Stream *	xlv_play_get_video_codec (XLV_PlayState *state)
	Returns the selected video codec. More...
gboolean	xlv_play_find_system (XLV_PlayState *state)
	find a good demultiplexer for the input stream.
void	xlv_prepare_to_play (XLV_PlayState *state)
	Prepare the object to play the input stream.
gboolean	xlv_play_start (XLV_PlayState *state)
	Start playing. More...
gboolean	xlv_play_stop (XLV_PlayState *state)
	Stop playing. More...
gboolean	xlv_play_pause (XLV_PlayState *state)
	Pause. More...
gboolean	xlv_play_alive (XLV_PlayState *state)
	Check if the playing is always alive. More...
gboolean	xlv_play_paused (XLV_PlayState *state)
	Check if the playing was paused. More...
gfloat	xlv_play_get_time_length (XLV_PlayState *state)
	Check the time length of the stream. More...
gfloat	xlv_play_get_current_time (XLV_PlayState *state)
	Check the current time. More...
gboolean	xlv_play_set_current_time (XLV_PlayState *state, gfloat time)
	Set the current time. More...
guint32	xlv_play_get_audio_bitrate (XLV_PlayState *state)
	Return the input audio bitrate. More...
guint32	xlv_play_get_video_bitrate (XLV_PlayState *state)
	Return the input video bitrate. More...
guint8	xlv_play_get_aq_use (XLV_PlayState *state)
	Return the percentage of the output audio queue used. More...
guint8	xlv_play_get_vq_use (XLV_PlayState *state)
	Return the percentage of the output video queue used. More...

---

Detailed Description

This is the playstate object.

---

Function Documentation

void xlv_close_play (  XLV_PlayState *    state )

XLV_PlayState destructor. Parameters: state  A valid XLV_PlayState object.

XLV_PlayState* xlv_open_play (  XLV_Session *    session, const gchar *    name )

an XLV_PlayState constructor. Parameters: session  A XLV_Session object fully initialized. name  A filename specifying the path to the multimedia content Returns: a new XLV_PlayState object.

XLV_PlayState* xlv_open_play_stream (  XLV_Session *    session, XLV_Stream *    stream )

an XLV_PlayState constructor. Parameters: session  A XLV_Session object fully initialized. stream  A XLV_Stream object fully opened, it must be READABLE. Returns: a new XLV_PlayState object.

XLV_PlayState* xlv_open_url_play (  XLV_Session *    session, const gchar *    name )

an XLV_PlayState constructor. Parameters: session  A XLV_Session object fully initialized. name  A URL specifying the path to the multimedia content Returns: a new XLV_PlayState object.

gboolean xlv_play_alive (  XLV_PlayState *    state )

Check if the playing is always alive. Parameters: state  a valid XLV_PlayState object. Returns: TRUE if it is always alive else FALSE.

guint8 xlv_play_get_aq_use (  XLV_PlayState *    state )

Return the percentage of the output audio queue used. Parameters: state  a valid XLV_PlayState object.

guint32 xlv_play_get_audio_bitrate (  XLV_PlayState *    state )

Return the input audio bitrate. Parameters: state  a valid XLV_PlayState object.

XLV_Stream* xlv_play_get_audio_codec (  XLV_PlayState *    state )

Returns the selected audio codec. Parameters: state  a valid XLV_PlayState. Returns: an initialized audio codec. This function returns the audio codec selected by the core to play the multimedia stream. Returns: a valid pointer if everything is OK, NULL if: XLV_PlayState is in PREINITIALIZATION mode. no valid audio codec were found on the computer. there is no audio stream in the input multimedia stream.

XLV_Stream* xlv_play_get_audio_renderer (  XLV_PlayState *    state )

Returns the current audio renderer. Parameters: state  a valid XLV_PlayState. Returns: an initialized XLV Audio Renderer.

gfloat xlv_play_get_current_time (  XLV_PlayState *    state )

Check the current time. Parameters: state  a valid XLV_PlayState object. Returns: It returns the time in seconds from the beginning of the stream.

gfloat xlv_play_get_time_length (  XLV_PlayState *    state )

Check the time length of the stream. Parameters: state  a valid XLV_PlayState object. Returns: Two possibilities: if it is a positive value, this is the length in seconds of the stream. if it is a negative value, it means that it is impossible to get the time length

guint32 xlv_play_get_video_bitrate (  XLV_PlayState *    state )

Return the input video bitrate. Parameters: state  a valid XLV_PlayState object.

XLV_Stream* xlv_play_get_video_codec (  XLV_PlayState *    state )

Returns the selected video codec. Parameters: state  a valid XLV_PlayState. Returns: an initialized video codec. This function returns the video codec selected by the core to play the multimedia stream. Returns: a valid pointer if everything is OK, NULL if: XLV_PlayState is in PREINITIALIZATION mode. no valid video codec were found on the computer. there is no video stream in the input multimedia stream.

XLV_Stream* xlv_play_get_video_renderer (  XLV_PlayState *    state )

Returns the current video renderer. Parameters: state  a valid XLV_PlayState. Returns: an initialized XLV Video Renderer

guint8 xlv_play_get_vq_use (  XLV_PlayState *    state )

Return the percentage of the output video queue used. Parameters: state  a valid XLV_PlayState object.

gboolean xlv_play_pause (  XLV_PlayState *    state )

Pause. Parameters: state  a valid XLV_PlayState object. Returns: TRUE if successful else FALSE.

gboolean xlv_play_paused (  XLV_PlayState *    state )

Check if the playing was paused. Parameters: state  a valid XLV_PlayState object. Returns: TRUE if it is paused else FALSE.

gboolean xlv_play_set_current_time (  XLV_PlayState *    state, gfloat    time )

Set the current time. Parameters: state  a valid XLV_PlayState object.

gboolean xlv_play_start (  XLV_PlayState *    state )

Start playing. Parameters: state  a valid XLV_PlayState object. Returns: TRUE if successful else FALSE.

gboolean xlv_play_stop (  XLV_PlayState *    state )

Stop playing. Parameters: state  a valid XLV_PlayState object. Returns: TRUE if successful else FALSE.

void xlv_set_audio_stream (  XLV_PlayState *    state, guint    stream_no )

This changes the current video stream used to build the output sound stream. Parameters: state  A valid XLV_PlayState stream_no  A valid stream number for the demultiplexer. If it is invalid, no change will be made.

void xlv_set_video_stream (  XLV_PlayState *    state, guint    stream_no )

This changes the current video stream used to build the output image. Parameters: state  A valid XLV_PlayState stream_no  A valid stream number for the demultiplexer. If it is invalid, no change will be made.

void xlv_setup_audio_output (  XLV_PlayState *    state, XLV_Stream *    audio_output )

Specifies which audio renderer we must use for the audio output. Parameters: state  a valid XLV_PlayState audio_output  a valid XLV Audio Renderer stream. This function changes the default audio output of the object. At initialization, XLV_PlayState use the file XLV_Session and the current list of available audio renderers to set its default audio output. This call overrides this. After that all audio output will be redirected to audio_output. Warning: You should not destroy audio_output after this call. XLV_PlayState will do it for you.

void xlv_setup_video_output (  XLV_PlayState *    state, XLV_Stream *    video_output )

Specifies which video renderer we must use for the video output. Parameters: state  a valid XLV_PlayState video_output  a valid XLV Video Renderer stream. This function changes the default video output of the object. At initialization, XLV_PlayState use the file XLV_Session and the current list of available video renderers to set its default video output. This call overrides this. After that all video output will be redirected to video_output. Warning: You should not destroy video_output after this call. XLV_PlayState will do it for you.

---