GstPlayer

GstPlayer.Player

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstPlayer.Player

GstPlayer.Player.prototype.new

function GstPlayer.Player.prototype.new(video_renderer: GstPlayer.PlayerVideoRenderer, signal_dispatcher: GstPlayer.PlayerSignalDispatcher): {
    // javascript wrapper for 'gst_player_new'
}

Creates a new GstPlayer.Player instance that uses signal_dispatcher to dispatch signals to some event loop system, or emits signals directly if NULL is passed. See GstPlayer.PlayerGMainContextSignalDispatcher.prototype.new.

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.

GstPlayer.Player.prototype.get_audio_video_offset

function GstPlayer.Player.prototype.get_audio_video_offset(): {
    // javascript wrapper for 'gst_player_get_audio_video_offset'
}

Retrieve the current value of audio-video-offset property

Since : 1.10

GstPlayer.Player.prototype.get_color_balance

function GstPlayer.Player.prototype.get_color_balance(type: GstPlayer.PlayerColorBalanceType): {
    // javascript wrapper for 'gst_player_get_color_balance'
}

Retrieve the current value of the indicated type.

GstPlayer.Player.prototype.get_config

function GstPlayer.Player.prototype.get_config(): {
    // javascript wrapper for 'gst_player_get_config'
}

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

Since : 1.10

GstPlayer.Player.prototype.get_current_audio_track

function GstPlayer.Player.prototype.get_current_audio_track(): {
    // javascript wrapper for 'gst_player_get_current_audio_track'
}

A Function to get current audio GstPlayer.PlayerAudioInfo instance.

GstPlayer.Player.prototype.get_current_subtitle_track

function GstPlayer.Player.prototype.get_current_subtitle_track(): {
    // javascript wrapper for 'gst_player_get_current_subtitle_track'
}

A Function to get current subtitle GstPlayer.PlayerSubtitleInfo instance.

GstPlayer.Player.prototype.get_current_video_track

function GstPlayer.Player.prototype.get_current_video_track(): {
    // javascript wrapper for 'gst_player_get_current_video_track'
}

A Function to get current video GstPlayer.PlayerVideoInfo instance.

GstPlayer.Player.prototype.get_current_visualization

function GstPlayer.Player.prototype.get_current_visualization(): {
    // javascript wrapper for 'gst_player_get_current_visualization'
}

GstPlayer.Player.prototype.get_duration

function GstPlayer.Player.prototype.get_duration(): {
    // javascript wrapper for 'gst_player_get_duration'
}

Retrieves the duration of the media stream that self represents.

GstPlayer.Player.prototype.get_media_info

function GstPlayer.Player.prototype.get_media_info(): {
    // javascript wrapper for 'gst_player_get_media_info'
}

A Function to get the current media info GstPlayer.PlayerMediaInfo instance.

GstPlayer.Player.prototype.get_multiview_flags

function GstPlayer.Player.prototype.get_multiview_flags(): {
    // javascript wrapper for 'gst_player_get_multiview_flags'
}

Retrieve the current value of the indicated type.

Since : 1.10

GstPlayer.Player.prototype.get_multiview_mode

function GstPlayer.Player.prototype.get_multiview_mode(): {
    // javascript wrapper for 'gst_player_get_multiview_mode'
}

Retrieve the current value of the indicated type.

Since : 1.10

GstPlayer.Player.prototype.get_mute

function GstPlayer.Player.prototype.get_mute(): {
    // javascript wrapper for 'gst_player_get_mute'
}

GstPlayer.Player.prototype.get_pipeline

function GstPlayer.Player.prototype.get_pipeline(): {
    // javascript wrapper for 'gst_player_get_pipeline'
}

GstPlayer.Player.prototype.get_position

function GstPlayer.Player.prototype.get_position(): {
    // javascript wrapper for 'gst_player_get_position'
}

GstPlayer.Player.prototype.get_rate

function GstPlayer.Player.prototype.get_rate(): {
    // javascript wrapper for 'gst_player_get_rate'
}

GstPlayer.Player.prototype.get_subtitle_uri

function GstPlayer.Player.prototype.get_subtitle_uri(): {
    // javascript wrapper for 'gst_player_get_subtitle_uri'
}

current subtitle URI

GstPlayer.Player.prototype.get_subtitle_video_offset

function GstPlayer.Player.prototype.get_subtitle_video_offset(): {
    // javascript wrapper for 'gst_player_get_subtitle_video_offset'
}

Retrieve the current value of subtitle-video-offset property

Since : 1.16

GstPlayer.Player.prototype.get_uri

function GstPlayer.Player.prototype.get_uri(): {
    // javascript wrapper for 'gst_player_get_uri'
}

Gets the URI of the currently-playing stream.

GstPlayer.Player.prototype.get_video_snapshot

function GstPlayer.Player.prototype.get_video_snapshot(format: GstPlayer.PlayerSnapshotFormat, config: Gst.Structure): {
    // javascript wrapper for 'gst_player_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_PLAYER_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1

Since : 1.12

GstPlayer.Player.prototype.get_volume

function GstPlayer.Player.prototype.get_volume(): {
    // javascript wrapper for 'gst_player_get_volume'
}

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

GstPlayer.Player.prototype.has_color_balance

function GstPlayer.Player.prototype.has_color_balance(): {
    // javascript wrapper for 'gst_player_has_color_balance'
}

Checks whether the player has color balance support available.

GstPlayer.Player.prototype.pause

function GstPlayer.Player.prototype.pause(): {
    // javascript wrapper for 'gst_player_pause'
}

Pauses the current stream.

GstPlayer.Player.prototype.play

function GstPlayer.Player.prototype.play(): {
    // javascript wrapper for 'gst_player_play'
}

Request to play the loaded stream.

GstPlayer.Player.prototype.seek

function GstPlayer.Player.prototype.seek(position: Number): {
    // javascript wrapper for 'gst_player_seek'
}

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

GstPlayer.Player.prototype.set_audio_track

function GstPlayer.Player.prototype.set_audio_track(stream_index: Number): {
    // javascript wrapper for 'gst_player_set_audio_track'
}

GstPlayer.Player.prototype.set_audio_track_enabled

function GstPlayer.Player.prototype.set_audio_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_player_set_audio_track_enabled'
}

Enable or disable the current audio track.

GstPlayer.Player.prototype.set_audio_video_offset

function GstPlayer.Player.prototype.set_audio_video_offset(offset: Number): {
    // javascript wrapper for 'gst_player_set_audio_video_offset'
}

Sets audio-video-offset property by value of offset

Since : 1.10

GstPlayer.Player.prototype.set_color_balance

function GstPlayer.Player.prototype.set_color_balance(type: GstPlayer.PlayerColorBalanceType, value: Number): {
    // javascript wrapper for 'gst_player_set_color_balance'
}

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

GstPlayer.Player.prototype.set_config

function GstPlayer.Player.prototype.set_config(config: Gst.Structure): {
    // javascript wrapper for 'gst_player_set_config'
}

Set the configuration of the player. If the player is already configured, and the configuration haven't change, this function will return true. If the player is not in the GST_PLAYER_STATE_STOPPED, this method will return false and active configuration will remain.

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

This function takes ownership of config.

Since : 1.10

GstPlayer.Player.prototype.set_multiview_flags

function GstPlayer.Player.prototype.set_multiview_flags(flags: GstVideo.VideoMultiviewFlags): {
    // javascript wrapper for 'gst_player_set_multiview_flags'
}

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

Since : 1.10

GstPlayer.Player.prototype.set_multiview_mode

function GstPlayer.Player.prototype.set_multiview_mode(mode: GstVideo.VideoMultiviewFramePacking): {
    // javascript wrapper for 'gst_player_set_multiview_mode'
}

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

Since : 1.10

GstPlayer.Player.prototype.set_mute

function GstPlayer.Player.prototype.set_mute(val: Number): {
    // javascript wrapper for 'gst_player_set_mute'
}

true if the currently-playing stream should be muted.

GstPlayer.Player.prototype.set_rate

function GstPlayer.Player.prototype.set_rate(rate: Number): {
    // javascript wrapper for 'gst_player_set_rate'
}

Playback at specified rate

GstPlayer.Player.prototype.set_subtitle_track

function GstPlayer.Player.prototype.set_subtitle_track(stream_index: Number): {
    // javascript wrapper for 'gst_player_set_subtitle_track'
}

GstPlayer.Player.prototype.set_subtitle_track_enabled

function GstPlayer.Player.prototype.set_subtitle_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_player_set_subtitle_track_enabled'
}

Enable or disable the current subtitle track.

GstPlayer.Player.prototype.set_subtitle_uri

function GstPlayer.Player.prototype.set_subtitle_uri(uri: String): {
    // javascript wrapper for 'gst_player_set_subtitle_uri'
}

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

GstPlayer.Player.prototype.set_subtitle_video_offset

function GstPlayer.Player.prototype.set_subtitle_video_offset(offset: Number): {
    // javascript wrapper for 'gst_player_set_subtitle_video_offset'
}

Sets subtitle-video-offset property by value of offset

Since : 1.16

GstPlayer.Player.prototype.set_uri

function GstPlayer.Player.prototype.set_uri(uri: String): {
    // javascript wrapper for 'gst_player_set_uri'
}

Sets the next URI to play.

GstPlayer.Player.prototype.set_video_track

function GstPlayer.Player.prototype.set_video_track(stream_index: Number): {
    // javascript wrapper for 'gst_player_set_video_track'
}

GstPlayer.Player.prototype.set_video_track_enabled

function GstPlayer.Player.prototype.set_video_track_enabled(enabled: Number): {
    // javascript wrapper for 'gst_player_set_video_track_enabled'
}

Enable or disable the current video track.

GstPlayer.Player.prototype.set_visualization

function GstPlayer.Player.prototype.set_visualization(name: String): {
    // javascript wrapper for 'gst_player_set_visualization'
}

GstPlayer.Player.prototype.set_visualization_enabled

function GstPlayer.Player.prototype.set_visualization_enabled(enabled: Number): {
    // javascript wrapper for 'gst_player_set_visualization_enabled'
}

Enable or disable the visualization.

GstPlayer.Player.prototype.set_volume

function GstPlayer.Player.prototype.set_volume(val: Number): {
    // javascript wrapper for 'gst_player_set_volume'
}

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

This volume is a linear factor. For showing the volume in a GUI it might make sense to first convert from a different format. Volume sliders should usually use a cubic volume. See GstAudio.prototype.stream_volume_convert_volume.

GstPlayer.Player.prototype.stop

function GstPlayer.Player.prototype.stop(): {
    // javascript wrapper for 'gst_player_stop'
}

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

GstPlayer.Player.prototype.config_get_position_update_interval

function GstPlayer.Player.prototype.config_get_position_update_interval(config: Gst.Structure): {
    // javascript wrapper for 'gst_player_config_get_position_update_interval'
}

Since : 1.10

GstPlayer.Player.prototype.config_get_seek_accurate

function GstPlayer.Player.prototype.config_get_seek_accurate(config: Gst.Structure): {
    // javascript wrapper for 'gst_player_config_get_seek_accurate'
}

Since : 1.12

GstPlayer.Player.prototype.config_get_user_agent

function GstPlayer.Player.prototype.config_get_user_agent(config: Gst.Structure): {
    // javascript wrapper for 'gst_player_config_get_user_agent'
}

Return the user agent which has been configured using GstPlayer.Player.prototype.config_set_user_agent if any.

Since : 1.10

GstPlayer.Player.prototype.config_set_position_update_interval

function GstPlayer.Player.prototype.config_set_position_update_interval(config: Gst.Structure, interval: Number): {
    // javascript wrapper for 'gst_player_config_set_position_update_interval'
}

set interval in milliseconds between two position-updated signals. pass 0 to stop updating the position.

Since : 1.10

GstPlayer.Player.prototype.config_set_seek_accurate

function GstPlayer.Player.prototype.config_set_seek_accurate(config: Gst.Structure, accurate: Number): {
    // javascript wrapper for 'gst_player_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.12

GstPlayer.Player.prototype.config_set_user_agent

function GstPlayer.Player.prototype.config_set_user_agent(config: Gst.Structure, agent: String): {
    // javascript wrapper for 'gst_player_config_set_user_agent'
}

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

Since : 1.10

GstPlayer.Player.prototype.get_audio_streams

function GstPlayer.Player.prototype.get_audio_streams(info: GstPlayer.PlayerMediaInfo): {
    // javascript wrapper for 'gst_player_get_audio_streams'
}

GstPlayer.Player.prototype.get_subtitle_streams

function GstPlayer.Player.prototype.get_subtitle_streams(info: GstPlayer.PlayerMediaInfo): {
    // javascript wrapper for 'gst_player_get_subtitle_streams'
}

GstPlayer.Player.prototype.get_video_streams

function GstPlayer.Player.prototype.get_video_streams(info: GstPlayer.PlayerMediaInfo): {
    // javascript wrapper for 'gst_player_get_video_streams'
}

GstPlayer.Player.prototype.visualizations_free

function GstPlayer.Player.prototype.visualizations_free(viss: GstPlayer.PlayerVisualization): {
    // javascript wrapper for 'gst_player_visualizations_free'
}

Frees a null terminated array of GstPlayer.PlayerVisualization.

GstPlayer.Player.prototype.visualizations_get

function GstPlayer.Player.prototype.visualizations_get(): {
    // javascript wrapper for 'gst_player_visualizations_get'
}

buffering

function buffering_callback(self: GstPlayer.Player, object: Number, user_data: Object): {
    // javascript callback for the 'buffering' signal
}

Flags: Run Last / No Hooks

duration-changed

function duration_changed_callback(self: GstPlayer.Player, object: Number, user_data: Object): {
    // javascript callback for the 'duration-changed' signal
}

Flags: Run Last / No Hooks

end-of-stream

function end_of_stream_callback(self: GstPlayer.Player, user_data: Object): {
    // javascript callback for the 'end-of-stream' signal
}

Flags: Run Last / No Hooks

error

function error_callback(self: GstPlayer.Player, object: GError (not introspectable), user_data: Object): {
    // javascript callback for the 'error' signal
}

Flags: Run Last / No Hooks

media-info-updated

function media_info_updated_callback(self: GstPlayer.Player, object: GstPlayer.PlayerMediaInfo, user_data: Object): {
    // javascript callback for the 'media-info-updated' signal
}

Flags: Run Last / No Hooks

mute-changed

function mute_changed_callback(self: GstPlayer.Player, user_data: Object): {
    // javascript callback for the 'mute-changed' signal
}

Flags: Run Last / No Hooks

position-updated

function position_updated_callback(self: GstPlayer.Player, object: Number, user_data: Object): {
    // javascript callback for the 'position-updated' signal
}

Flags: Run Last / No Hooks

seek-done

function seek_done_callback(self: GstPlayer.Player, object: Number, user_data: Object): {
    // javascript callback for the 'seek-done' signal
}

Flags: Run Last / No Hooks

state-changed

function state_changed_callback(self: GstPlayer.Player, object: GstPlayer.PlayerState, user_data: Object): {
    // javascript callback for the 'state-changed' signal
}

Flags: Run Last / No Hooks

uri-loaded

function uri_loaded_callback(self: GstPlayer.Player, object: String, user_data: Object): {
    // javascript callback for the 'uri-loaded' signal
}

Flags: Run Last / No Hooks

video-dimensions-changed

function video_dimensions_changed_callback(self: GstPlayer.Player, object: Number, p0: Number, user_data: Object): {
    // javascript callback for the 'video-dimensions-changed' signal
}

Flags: Run Last / No Hooks

volume-changed

function volume_changed_callback(self: GstPlayer.Player, user_data: Object): {
    // javascript callback for the 'volume-changed' signal
}

Flags: Run Last / No Hooks

warning

function warning_callback(self: GstPlayer.Player, object: GError (not introspectable), user_data: Object): {
    // javascript callback for the 'warning' signal
}

Flags: Run Last / No Hooks

audio-video-offset

“audio-video-offset” Number

Flags : Read / Write

current-audio-track

“current-audio-track” GstPlayer.PlayerAudioInfo

Flags : Read

current-subtitle-track

“current-subtitle-track” GstPlayer.PlayerSubtitleInfo

Flags : Read

current-video-track

“current-video-track” GstPlayer.PlayerVideoInfo

Flags : Read

duration

“duration” Number

Flags : Read

media-info

“media-info” GstPlayer.PlayerMediaInfo

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

signal-dispatcher

“signal-dispatcher” GstPlayer.PlayerSignalDispatcher

Flags : Read / Write / Construct Only

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” GstPlayer.PlayerVideoRenderer

Flags : Read / Write / Construct Only

volume

“volume” Number

Flags : Read / Write

GstPlayer.PlayerColorBalanceType.prototype.get_name

function GstPlayer.PlayerColorBalanceType.prototype.get_name(type: GstPlayer.PlayerColorBalanceType): {
    // javascript wrapper for 'gst_player_color_balance_type_get_name'
}

Gets a string representing the given color balance type.

GstPlayer.PlayerError.prototype.get_name

function GstPlayer.PlayerError.prototype.get_name(error: GstPlayer.PlayerError): {
    // javascript wrapper for 'gst_player_error_get_name'
}

Gets a string representing the given error.

GstPlayer.PlayerError.prototype.quark

function GstPlayer.PlayerError.prototype.quark(): {
    // javascript wrapper for 'gst_player_error_quark'
}

GstPlayer.PlayerState.prototype.get_name

function GstPlayer.PlayerState.prototype.get_name(state: GstPlayer.PlayerState): {
    // javascript wrapper for 'gst_player_state_get_name'
}

Gets a string representing the given state.

GstPlayer.PlayerColorBalanceType

GstPlayer.PlayerError

GstPlayer.PlayerSnapshotFormat

GstPlayer.PlayerState