Functions¶

	`play_color_balance_type_get_name` (type)
	`play_error_get_name` (error)
	`play_error_quark` ()
	`play_loop_get_name` (loop)
	`play_message_get_name` (message_type)
	`play_message_get_stream_id` (msg)
	`play_message_get_uri` (msg)
	`play_message_parse_buffering` (msg)
	`play_message_parse_buffering_percent` (msg)
	`play_message_parse_duration_changed` (msg)
	`play_message_parse_duration_updated` (msg)
	`play_message_parse_error` (msg)
	`play_message_parse_error_missing_plugin` (msg)
	`play_message_parse_media_info_updated` (msg)
	`play_message_parse_muted_changed` (msg)
	`play_message_parse_position_updated` (msg)
	`play_message_parse_seek_done` (msg)
	`play_message_parse_state_changed` (msg)
	`play_message_parse_type` (msg)
	`play_message_parse_uri_loaded` (msg)
	`play_message_parse_video_dimensions_changed` (msg)
	`play_message_parse_volume_changed` (msg)
	`play_message_parse_warning` (msg)
	`play_message_parse_warning_missing_plugin` (msg)
	`play_state_get_name` (state)

Details¶

GstPlay.play_color_balance_type_get_name(type)¶

Parameters:: type (GstPlay.PlayColorBalanceType) – a GstPlay.PlayColorBalanceType
Returns:: a string with the name of the color balance type.
Return type:: str

Gets a string representing the given color balance type.

Added in version 1.20.

GstPlay.play_error_get_name(error)¶

Parameters:: error (GstPlay.PlayError) – a GstPlay.PlayError
Returns:: a string with the given error.
Return type:: str

Gets a string representing the given error.

Added in version 1.20.

GstPlay.play_error_quark()¶

Return type:: int

Added in version 1.20.

GstPlay.play_loop_get_name(loop)¶

Parameters:: loop (GstPlay.PlayLoop) – a GstPlay.PlayLoop
Returns:: a string with the name of the loop.
Return type:: str

Added in version 1.28.

GstPlay.play_message_get_name(message_type)¶

Parameters:: message_type (GstPlay.PlayMessage) – a GstPlay.PlayMessage
Returns:: a string with the name of the message.
Return type:: str

Added in version 1.20.

GstPlay.play_message_get_stream_id(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: The stream ID this message applies to
Return type:: str or None

Reads the stream ID the play message msg applies to, if any.

Added in version 1.26.

GstPlay.play_message_get_uri(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: The URI this message applies to
Return type:: str

Reads the URI the play message msg applies to.

Added in version 1.26.

GstPlay.play_message_parse_buffering(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting buffering percent
Return type:: percent: int

Parse the given buffering msg and extract the corresponding value

Added in version 1.26.

GstPlay.play_message_parse_buffering_percent(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting buffering percent
Return type:: percent: int

Parse the given buffering msg and extract the corresponding value

Added in version 1.20.

Deprecated since version 1.26: Use GstPlay.PlayMessage.parse_buffering().

GstPlay.play_message_parse_duration_changed(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting duration
Return type:: duration: int

Parse the given duration-changed msg and extract the corresponding #GstClockTime

Added in version 1.26.

GstPlay.play_message_parse_duration_updated(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting duration
Return type:: duration: int

Parse the given duration-changed msg and extract the corresponding #GstClockTime

Added in version 1.20.

Deprecated since version 1.26: Use GstPlay.PlayMessage.parse_duration_changed().

GstPlay.play_message_parse_error(msg)¶

Parameters:

msg (Gst.Message) – A Gst.Message

Returns:

error:: the resulting error
details:: A Gst.Structure containing additional details about the error

Return type:

(error: GLib.Error, details: Gst.Structure or None)

Parse the given error msg and extract the corresponding GLib.Error.

Since 1.26 the details will always contain the URI this refers to in an “uri” field of type string, and (if known) the string “stream-id” it is referring to.

Added in version 1.20.

GstPlay.play_message_parse_error_missing_plugin(msg)¶

Parameters:

msg (Gst.Message) – A Gst.Message

Returns:

True if the message contained a missing-plugin error.

descriptions:: a None-terminated array of descriptions
installer_details:: a None-terminated array of installer details

Return type:

(bool, descriptions: [str], installer_details: [str])

Parses missing plugin descriptions and installer details from a GST_PLAY_ERROR_MISSING_PLUGIN error message.

Both arrays will have the same length, and strings at the same index correspond to each other.

The installer details can be passed to GstPbutils.install_plugins_sync() or GstPbutils.install_plugins_async().

Added in version 1.26.

GstPlay.play_message_parse_media_info_updated(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting media info
Return type:: info: GstPlay.PlayMediaInfo

Parse the given media-info-updated msg and extract the corresponding media information

Added in version 1.20.

GstPlay.play_message_parse_muted_changed(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting audio muted state
Return type:: muted: bool

Parse the given mute-changed msg and extract the corresponding audio muted state

Added in version 1.20.

GstPlay.play_message_parse_position_updated(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting position
Return type:: position: int

Parse the given position-updated msg and extract the corresponding #GstClockTime

Added in version 1.20.

GstPlay.play_message_parse_seek_done(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting position
Return type:: position: int

Parse the given seek-done msg and extract the corresponding #GstClockTime

Added in version 1.26.

GstPlay.play_message_parse_state_changed(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting play state
Return type:: state: GstPlay.PlayState

Parse the given state-changed msg and extract the corresponding GstPlay.PlayState

Added in version 1.20.

GstPlay.play_message_parse_type(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting message type
Return type:: type: GstPlay.PlayMessage

Parse the given msg and extract its GstPlay.PlayMessage type.

Added in version 1.20.

GstPlay.play_message_parse_uri_loaded(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting URI
Return type:: uri: str

Parse the given uri-loaded msg and extract the corresponding value

Added in version 1.26.

GstPlay.play_message_parse_video_dimensions_changed(msg)¶

Parameters:

msg (Gst.Message) – A Gst.Message

Returns:

width:: the resulting video width
height:: the resulting video height

Return type:

(width: int, height: int)

Parse the given video-dimensions-changed msg and extract the corresponding video dimensions

Added in version 1.20.

GstPlay.play_message_parse_volume_changed(msg)¶

Parameters:: msg (Gst.Message) – A Gst.Message
Returns:: the resulting audio volume
Return type:: volume: float

Parse the given volume-changed msg and extract the corresponding audio volume

Added in version 1.20.

GstPlay.play_message_parse_warning(msg)¶

Parameters:

msg (Gst.Message) – A Gst.Message

Returns:

error:: the resulting warning
details:: A Gst.Structure containing additional details about the warning

Return type:

(error: GLib.Error, details: Gst.Structure or None)

Parse the given warning msg and extract the corresponding GLib.Error.

Since 1.26 the details will always contain the URI this refers to in an “uri” field of type string, and (if known) the string “stream-id” it is referring to.

Added in version 1.20.

GstPlay.play_message_parse_warning_missing_plugin(msg)¶

Parameters:

msg (Gst.Message) – A Gst.Message

Returns:

True if the message contained a missing-plugin error.

descriptions:: a None-terminated array of descriptions
installer_details:: a None-terminated array of installer details

Return type:

(bool, descriptions: [str], installer_details: [str])

Parses missing plugin descriptions and installer details from a GST_PLAY_ERROR_MISSING_PLUGIN warning message.

Both arrays will have the same length, and strings at the same index correspond to each other.

The installer details can be passed to GstPbutils.install_plugins_sync() or GstPbutils.install_plugins_async().

Added in version 1.26.

GstPlay.play_state_get_name(state)¶

Parameters:: state (GstPlay.PlayState) – a GstPlay.PlayState
Returns:: a string with the name of the state.
Return type:: str

Gets a string representing the given state.

Added in version 1.20.