GstPlay

GstPlay.Play

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstPlay.Play

Since : 1.20

GstPlay.Play.prototype.new

function GstPlay.Play.prototype.new(video_renderer: GstPlay.PlayVideoRenderer): {
    // javascript wrapper for 'gst_play_new'
}

Creates a new GstPlay.Play instance.

Video is going to be rendered by video_renderer, or if null is provided no special video set up will be done and some default handling will be performed.

This also initializes GStreamer via gst_init() on the first call if this didn't happen before.

Since : 1.20

GstPlay.Play.prototype.get_audio_video_offset

function GstPlay.Play.prototype.get_audio_video_offset(): {
    // javascript wrapper for 'gst_play_get_audio_video_offset'
}

Retrieve the current value of audio-video-offset property

Since : 1.20

GstPlay.Play.prototype.get_color_balance

function GstPlay.Play.prototype.get_color_balance(type: GstPlay.PlayColorBalanceType): {
    // javascript wrapper for 'gst_play_get_color_balance'
}

Retrieve the current value of the indicated type.

Since : 1.20

GstPlay.Play.prototype.get_config

function GstPlay.Play.prototype.get_config(): {
    // javascript wrapper for 'gst_play_get_config'
}

Get a copy of the current configuration of the play. This configuration can either be modified and used for the GstPlay.Play.prototype.set_config call or it must be freed after usage.

Since : 1.20

GstPlay.Play.prototype.get_current_audio_track

function GstPlay.Play.prototype.get_current_audio_track(): {
    // javascript wrapper for 'gst_play_get_current_audio_track'
}

A Function to get current audio GstPlay.PlayAudioInfo instance.

Since : 1.20

GstPlay.Play.prototype.get_current_subtitle_track

function GstPlay.Play.prototype.get_current_subtitle_track(): {
    // javascript wrapper for 'gst_play_get_current_subtitle_track'
}

A Function to get current subtitle GstPlay.PlaySubtitleInfo instance.

Since : 1.20

GstPlay.Play.prototype.get_current_video_track

function GstPlay.Play.prototype.get_current_video_track(): {
    // javascript wrapper for 'gst_play_get_current_video_track'
}

A Function to get current video GstPlay.PlayVideoInfo instance.

Since : 1.20

GstPlay.Play.prototype.get_current_visualization

function GstPlay.Play.prototype.get_current_visualization(): {
    // javascript wrapper for 'gst_play_get_current_visualization'
}

Since : 1.20

GstPlay.Play.prototype.get_duration

function GstPlay.Play.prototype.get_duration(): {
    // javascript wrapper for 'gst_play_get_duration'
}

Retrieves the duration of the media stream that self represents.

Since : 1.20

GstPlay.Play.prototype.get_media_info

function GstPlay.Play.prototype.get_media_info(): {
    // javascript wrapper for 'gst_play_get_media_info'
}

A Function to get the current media info GstPlay.PlayMediaInfo instance.

Since : 1.20

GstPlay.Play.prototype.get_message_bus

function GstPlay.Play.prototype.get_message_bus(): {
    // javascript wrapper for 'gst_play_get_message_bus'
}

GstPlay API exposes a Gst.Bus instance which purpose is to provide data structures representing play-internal events in form of Gst.Messages of type GST_MESSAGE_APPLICATION.

Each message carries a "play-message" field of type GstPlay.PlayMessage. Further fields of the message data are specific to each possible value of that enumeration.

Applications can consume the messages asynchronously within their own event-loop / UI-thread etc. Note that in case the application does not consume the messages, the bus will accumulate these internally and eventually fill memory. To avoid that, the bus has to be set "flushing".

Since : 1.20

GstPlay.Play.prototype.get_multiview_flags

function GstPlay.Play.prototype.get_multiview_flags(): {
    // javascript wrapper for 'gst_play_get_multiview_flags'
}

Retrieve the current value of the indicated type.

Since : 1.20

GstPlay.Play.prototype.get_multiview_mode

function GstPlay.Play.prototype.get_multiview_mode(): {
    // javascript wrapper for 'gst_play_get_multiview_mode'
}

Retrieve the current value of the indicated type.

Since : 1.20

GstPlay.Play.prototype.get_mute

function GstPlay.Play.prototype.get_mute(): {
    // javascript wrapper for 'gst_play_get_mute'
}

Since : 1.20

GstPlay.Play.prototype.get_pipeline

function GstPlay.Play.prototype.get_pipeline(): {
    // javascript wrapper for 'gst_play_get_pipeline'
}

Since : 1.20

GstPlay.Play.prototype.get_position

function GstPlay.Play.prototype.get_position(): {
    // javascript wrapper for 'gst_play_get_position'
}

Since : 1.20

GstPlay.Play.prototype.get_rate

function GstPlay.Play.prototype.get_rate(): {
    // javascript wrapper for 'gst_play_get_rate'
}

Since : 1.20

GstPlay.Play.prototype.get_subtitle_uri

function GstPlay.Play.prototype.get_subtitle_uri(): {
    // javascript wrapper for 'gst_play_get_subtitle_uri'
}

Current subtitle URI

Since : 1.20

GstPlay.Play.prototype.get_subtitle_video_offset

function GstPlay.Play.prototype.get_subtitle_video_offset(): {
    // javascript wrapper for 'gst_play_get_subtitle_video_offset'
}

Retrieve the current value of subtitle-video-offset property

Since : 1.20

GstPlay.Play.prototype.get_uri

function GstPlay.Play.prototype.get_uri(): {
    // javascript wrapper for 'gst_play_get_uri'
}

Gets the URI of the currently-playing stream.

Since : 1.20

GstPlay.Play.prototype.get_video_snapshot

function GstPlay.Play.prototype.get_video_snapshot(format: GstPlay.PlaySnapshotFormat, config: Gst.Structure): {
    // javascript wrapper for 'gst_play_get_video_snapshot'
}

Get a snapshot of the currently selected video stream, if any. The format can be selected with format and optional configuration is possible with config. Currently supported settings are:

• width, height of type G_TYPE_INT
• pixel-aspect-ratio of type GST_TYPE_FRACTION Except for GST_PLAY_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1

Since : 1.20

GstPlay.Play.prototype.get_volume

function GstPlay.Play.prototype.get_volume(): {
    // javascript wrapper for 'gst_play_get_volume'
}

Returns the current volume level, as a percentage between 0 and 1.

Since : 1.20

GstPlay.Play.prototype.has_color_balance

function GstPlay.Play.prototype.has_color_balance(): {
    // javascript wrapper for 'gst_play_has_color_balance'
}

Checks whether the play has color balance support available.

Since : 1.20

GstPlay.Play.prototype.pause

function GstPlay.Play.prototype.pause(): {
    // javascript wrapper for 'gst_play_pause'
}

Pauses the current stream.

Since : 1.20

GstPlay.Play.prototype.play

function GstPlay.Play.prototype.play(): {
    // javascript wrapper for 'gst_play_play'
}

Request to play the loaded stream.

Since : 1.20

GstPlay.Play.prototype.seek

function GstPlay.Play.prototype.seek(position: Number): {
    // javascript wrapper for 'gst_play_seek'
}

Seeks the currently-playing stream to the absolute position time in nanoseconds.

Since : 1.20

GstPlay.Play.prototype.set_audio_track

function GstPlay.Play.prototype.set_audio_track(stream_index: Number): {
    // javascript wrapper for 'gst_play_set_audio_track'
}

Since : 1.20

GstPlay.Play.prototype.set_audio_track_enabled

function GstPlay.Play.prototype.set_audio_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_play_set_audio_track_enabled'
}

Enable or disable the current audio track.

Since : 1.20

GstPlay.Play.prototype.set_audio_video_offset

function GstPlay.Play.prototype.set_audio_video_offset(offset: Number): {
    // javascript wrapper for 'gst_play_set_audio_video_offset'
}

Sets audio-video-offset property by value of offset

Since : 1.20

GstPlay.Play.prototype.set_color_balance

function GstPlay.Play.prototype.set_color_balance(type: GstPlay.PlayColorBalanceType, value: Number): {
    // javascript wrapper for 'gst_play_set_color_balance'
}

Sets the current value of the indicated channel type to the passed value.

Since : 1.20

GstPlay.Play.prototype.set_config

function GstPlay.Play.prototype.set_config(config: Gst.Structure): {
    // javascript wrapper for 'gst_play_set_config'
}

Set the configuration of the play. If the play is already configured, and the configuration hasn't changed, this function will return true. If the play is not in the GST_PLAY_STATE_STOPPED, this method will return false and active configuration will remain.

config is a Gst.Structure that contains the configuration parameters for the play.

This function takes ownership of config.

Since : 1.20

GstPlay.Play.prototype.set_multiview_flags

function GstPlay.Play.prototype.set_multiview_flags(flags: GstVideo.VideoMultiviewFlags): {
    // javascript wrapper for 'gst_play_set_multiview_flags'
}

Sets the current value of the indicated mode type to the passed value.

Since : 1.20

GstPlay.Play.prototype.set_multiview_mode

function GstPlay.Play.prototype.set_multiview_mode(mode: GstVideo.VideoMultiviewFramePacking): {
    // javascript wrapper for 'gst_play_set_multiview_mode'
}

Sets the current value of the indicated mode type to the passed value.

Since : 1.20

GstPlay.Play.prototype.set_mute

function GstPlay.Play.prototype.set_mute(val: Number): {
    // javascript wrapper for 'gst_play_set_mute'
}

true if the currently-playing stream should be muted.

Since : 1.20

GstPlay.Play.prototype.set_rate

function GstPlay.Play.prototype.set_rate(rate: Number): {
    // javascript wrapper for 'gst_play_set_rate'
}

Playback at specified rate

Since : 1.20

GstPlay.Play.prototype.set_subtitle_track

function GstPlay.Play.prototype.set_subtitle_track(stream_index: Number): {
    // javascript wrapper for 'gst_play_set_subtitle_track'
}

Since : 1.20

GstPlay.Play.prototype.set_subtitle_track_enabled

function GstPlay.Play.prototype.set_subtitle_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_play_set_subtitle_track_enabled'
}

Enable or disable the current subtitle track.

Since : 1.20

GstPlay.Play.prototype.set_subtitle_uri

function GstPlay.Play.prototype.set_subtitle_uri(uri: String): {
    // javascript wrapper for 'gst_play_set_subtitle_uri'
}

Sets the external subtitle URI. This should be combined with a call to gst_play_set_subtitle_track_enabled(@play, TRUE) so the subtitles are actually rendered.

Since : 1.20

GstPlay.Play.prototype.set_subtitle_video_offset

function GstPlay.Play.prototype.set_subtitle_video_offset(offset: Number): {
    // javascript wrapper for 'gst_play_set_subtitle_video_offset'
}

Sets subtitle-video-offset property by value of offset

Since : 1.20

GstPlay.Play.prototype.set_uri

function GstPlay.Play.prototype.set_uri(uri: String): {
    // javascript wrapper for 'gst_play_set_uri'
}

Sets the next URI to play.

Since : 1.20

GstPlay.Play.prototype.set_video_track

function GstPlay.Play.prototype.set_video_track(stream_index: Number): {
    // javascript wrapper for 'gst_play_set_video_track'
}

Since : 1.20

GstPlay.Play.prototype.set_video_track_enabled

function GstPlay.Play.prototype.set_video_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_play_set_video_track_enabled'
}

Enable or disable the current video track.

Since : 1.20

GstPlay.Play.prototype.set_visualization

function GstPlay.Play.prototype.set_visualization(name: String): {
    // javascript wrapper for 'gst_play_set_visualization'
}

Since : 1.20

GstPlay.Play.prototype.set_visualization_enabled

function GstPlay.Play.prototype.set_visualization_enabled(enabled: Number): {
    // javascript wrapper for 'gst_play_set_visualization_enabled'
}

Enable or disable the visualization.

Since : 1.20

GstPlay.Play.prototype.set_volume

function GstPlay.Play.prototype.set_volume(val: Number): {
    // javascript wrapper for 'gst_play_set_volume'
}

Sets the volume level of the stream as a percentage between 0 and 1.

Since : 1.20

GstPlay.Play.prototype.stop

function GstPlay.Play.prototype.stop(): {
    // javascript wrapper for 'gst_play_stop'
}

Stops playing the current stream and resets to the first position in the stream.

Since : 1.20

GstPlay.Play.prototype.config_get_pipeline_dump_in_error_details

function GstPlay.Play.prototype.config_get_pipeline_dump_in_error_details(config: Gst.Structure): {
    // javascript wrapper for 'gst_play_config_get_pipeline_dump_in_error_details'
}

Since : 1.24

GstPlay.Play.prototype.config_get_position_update_interval

function GstPlay.Play.prototype.config_get_position_update_interval(config: Gst.Structure): {
    // javascript wrapper for 'gst_play_config_get_position_update_interval'
}

Since : 1.20

GstPlay.Play.prototype.config_get_seek_accurate

function GstPlay.Play.prototype.config_get_seek_accurate(config: Gst.Structure): {
    // javascript wrapper for 'gst_play_config_get_seek_accurate'
}

Since : 1.20

GstPlay.Play.prototype.config_get_user_agent

function GstPlay.Play.prototype.config_get_user_agent(config: Gst.Structure): {
    // javascript wrapper for 'gst_play_config_get_user_agent'
}

Return the user agent which has been configured using GstPlay.Play.prototype.config_set_user_agent if any.

Since : 1.20

GstPlay.Play.prototype.config_set_pipeline_dump_in_error_details

function GstPlay.Play.prototype.config_set_pipeline_dump_in_error_details(config: Gst.Structure, value: Number): {
    // javascript wrapper for 'gst_play_config_set_pipeline_dump_in_error_details'
}

When enabled, the error message emitted by GstPlay.Play will include a pipeline dump (in Graphviz DOT format) in the error details Gst.Structure. The field name is pipeline-dump.

This option is disabled by default.

Since : 1.24

GstPlay.Play.prototype.config_set_position_update_interval

function GstPlay.Play.prototype.config_set_position_update_interval(config: Gst.Structure, interval: Number): {
    // javascript wrapper for 'gst_play_config_set_position_update_interval'
}

Set desired interval in milliseconds between two position-updated messages. Pass 0 to stop updating the position.

Since : 1.20

GstPlay.Play.prototype.config_set_seek_accurate

function GstPlay.Play.prototype.config_set_seek_accurate(config: Gst.Structure, accurate: Number): {
    // javascript wrapper for 'gst_play_config_set_seek_accurate'
}

Enable or disable accurate seeking. When enabled, elements will try harder to seek as accurately as possible to the requested seek position. Generally it will be slower especially for formats that don't have any indexes or timestamp markers in the stream.

If accurate seeking is disabled, elements will seek as close as the request position without slowing down seeking too much.

Accurate seeking is disabled by default.

Since : 1.20

GstPlay.Play.prototype.config_set_user_agent

function GstPlay.Play.prototype.config_set_user_agent(config: Gst.Structure, agent: String): {
    // javascript wrapper for 'gst_play_config_set_user_agent'
}

Set the user agent to pass to the server if play needs to connect to a server during playback. This is typically used when playing HTTP or RTSP streams.

Since : 1.20

GstPlay.Play.prototype.get_audio_streams

function GstPlay.Play.prototype.get_audio_streams(info: GstPlay.PlayMediaInfo): {
    // javascript wrapper for 'gst_play_get_audio_streams'
}

Since : 1.20

GstPlay.Play.prototype.get_subtitle_streams

function GstPlay.Play.prototype.get_subtitle_streams(info: GstPlay.PlayMediaInfo): {
    // javascript wrapper for 'gst_play_get_subtitle_streams'
}

Since : 1.20

GstPlay.Play.prototype.get_video_streams

function GstPlay.Play.prototype.get_video_streams(info: GstPlay.PlayMediaInfo): {
    // javascript wrapper for 'gst_play_get_video_streams'
}

Since : 1.20

GstPlay.Play.prototype.is_play_message

function GstPlay.Play.prototype.is_play_message(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_is_play_message'
}

Since : 1.20

GstPlay.Play.prototype.visualizations_free

function GstPlay.Play.prototype.visualizations_free(viss: GstPlay.PlayVisualization): {
    // javascript wrapper for 'gst_play_visualizations_free'
}

Frees a null terminated array of GstPlay.PlayVisualization.

Since : 1.20

GstPlay.Play.prototype.visualizations_get

function GstPlay.Play.prototype.visualizations_get(): {
    // javascript wrapper for 'gst_play_visualizations_get'
}

Since : 1.20

audio-video-offset

“audio-video-offset” Number

Flags : Read / Write

current-audio-track

“current-audio-track” GstPlay.PlayAudioInfo

Flags : Read

current-subtitle-track

“current-subtitle-track” GstPlay.PlaySubtitleInfo

Flags : Read

current-video-track

“current-video-track” GstPlay.PlayVideoInfo

Flags : Read

duration

“duration” Number

Flags : Read

media-info

“media-info” GstPlay.PlayMediaInfo

Flags : Read

mute

“mute” Number

Flags : Read / Write

pipeline

“pipeline” Gst.Element

Flags : Read

position

“position” Number

Flags : Read

rate

“rate” Number

Flags : Read / Write

subtitle-video-offset

“subtitle-video-offset” Number

Flags : Read / Write

suburi

“suburi” String

Flags : Read / Write

uri

“uri” String

Flags : Read / Write

video-multiview-flags

“video-multiview-flags” GstVideo.VideoMultiviewFlags

Flags : Read / Write

video-multiview-mode

“video-multiview-mode” GstVideo.VideoMultiviewFramePacking

Flags : Read / Write

video-renderer

“video-renderer” GstPlay.PlayVideoRenderer

Flags : Read / Write

volume

“volume” Number

Flags : Read / Write

GstPlay.PlayColorBalanceType.prototype.get_name

function GstPlay.PlayColorBalanceType.prototype.get_name(type: GstPlay.PlayColorBalanceType): {
    // javascript wrapper for 'gst_play_color_balance_type_get_name'
}

Gets a string representing the given color balance type.

Since : 1.20

GstPlay.PlayError.prototype.get_name

function GstPlay.PlayError.prototype.get_name(error: GstPlay.PlayError): {
    // javascript wrapper for 'gst_play_error_get_name'
}

Gets a string representing the given error.

Since : 1.20

GstPlay.PlayError.prototype.quark

function GstPlay.PlayError.prototype.quark(): {
    // javascript wrapper for 'gst_play_error_quark'
}

Since : 1.20

GstPlay.PlayMessage.prototype.get_name

function GstPlay.PlayMessage.prototype.get_name(message_type: GstPlay.PlayMessage): {
    // javascript wrapper for 'gst_play_message_get_name'
}

Since : 1.20

GstPlay.PlayMessage.prototype.parse_buffering

function GstPlay.PlayMessage.prototype.parse_buffering(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_buffering'
}

Parse the given buffering msg and extract the corresponding value

Since : 1.26

GstPlay.PlayMessage.prototype.parse_buffering_percent

function GstPlay.PlayMessage.prototype.parse_buffering_percent(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_buffering_percent'
}

Parse the given buffering msg and extract the corresponding value

Since : 1.20

deprecated : 1.26: Use gst_play_message_parse_buffering().

GstPlay.PlayMessage.prototype.parse_duration_changed

function GstPlay.PlayMessage.prototype.parse_duration_changed(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_duration_changed'
}

Parse the given duration-changed msg and extract the corresponding Number

Since : 1.26

GstPlay.PlayMessage.prototype.parse_duration_updated

function GstPlay.PlayMessage.prototype.parse_duration_updated(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_duration_updated'
}

Parse the given duration-changed msg and extract the corresponding Number

Since : 1.20

deprecated : 1.26: Use gst_play_message_parse_duration_changed().

GstPlay.PlayMessage.prototype.parse_error

function GstPlay.PlayMessage.prototype.parse_error(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_error'
}

Parse the given error msg and extract the corresponding GError (not introspectable)

Since : 1.20

GstPlay.PlayMessage.prototype.parse_media_info_updated

function GstPlay.PlayMessage.prototype.parse_media_info_updated(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_media_info_updated'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_muted_changed

function GstPlay.PlayMessage.prototype.parse_muted_changed(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_muted_changed'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_position_updated

function GstPlay.PlayMessage.prototype.parse_position_updated(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_position_updated'
}

Parse the given position-updated msg and extract the corresponding Number

Since : 1.20

GstPlay.PlayMessage.prototype.parse_seek_done

function GstPlay.PlayMessage.prototype.parse_seek_done(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_seek_done'
}

Parse the given seek-done msg and extract the corresponding Number

Since : 1.26

GstPlay.PlayMessage.prototype.parse_state_changed

function GstPlay.PlayMessage.prototype.parse_state_changed(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_state_changed'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_type

function GstPlay.PlayMessage.prototype.parse_type(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_type'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_uri_loaded

function GstPlay.PlayMessage.prototype.parse_uri_loaded(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_uri_loaded'
}

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

Since : 1.26

GstPlay.PlayMessage.prototype.parse_video_dimensions_changed

function GstPlay.PlayMessage.prototype.parse_video_dimensions_changed(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_video_dimensions_changed'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_volume_changed

function GstPlay.PlayMessage.prototype.parse_volume_changed(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_volume_changed'
}

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

Since : 1.20

GstPlay.PlayMessage.prototype.parse_warning

function GstPlay.PlayMessage.prototype.parse_warning(msg: Gst.Message): {
    // javascript wrapper for 'gst_play_message_parse_warning'
}

Parse the given warning msg and extract the corresponding GError (not introspectable)

Since : 1.20