Player

---

Object Hierarchy:

Description:

Content:

Properties:

• public uint adaptive_bandwidth { get; }
  Last fragment download bandwidth (bits/s) during adaptive streaming.
• public uint adaptive_max_bitrate { get; set; }
  A maximal allowed bitrate (bits/s) during adaptive streaming such as DASH or HLS (`0` for unlimited).
• public uint adaptive_min_bitrate { get; set; }
  A minimal allowed bitrate (bits/s) during adaptive streaming such as DASH or HLS.
• public uint adaptive_start_bitrate { get; set; }
  An initial bitrate (bits/s) to select during starting adaptive streaming such as DASH or HLS.
• public bool audio_enabled { get; set; }
  Whether audio stream is enabled.
• public Element audio_filter { owned get; set; }
  Optional audio filter to use (none by default).
• public double audio_offset { get; set; }
  Audio stream offset relative to video.
• public Element audio_sink { owned get; set; }
  Audio sink to use (autoaudiosink by default).
• public StreamList audio_streams { get; }
  List of currently available audio streams.
• public bool autoplay { get; set; }
  Always try to start playback after media item changes.
• public Element current_audio_decoder { owned get; }
  Currently used audio decoder.
• public Element current_video_decoder { owned get; }
  Currently used video decoder.
• public string download_dir { owned get; set; }
  A directory that player will use to download network content when [property@Clapper.
• public bool download_enabled { get; set; }
  Whether progressive download buffering is enabled.
• public EnhancerProxyList enhancer_proxies { get; }
  List of available enhancers in the form of [class@Clapper.
• public bool mute { get; set; }
  Mute audio without changing volume.
• public double position { get; }
  Current playback position as a decimal number in seconds.
• public Queue queue { get; }
  Clapper playback queue.
• public double speed { get; set; }
  Current playback speed.
• public PlayerState state { get; }
  Current playback state.
• public string subtitle_font_desc { owned get; set; }
  Subtitle stream font description.
• public double subtitle_offset { get; set; }
  Subtitle stream offset relative to video.
• public StreamList subtitle_streams { get; }
  List of currently available subtitle streams.
• public bool subtitles_enabled { get; set; }
  Whether subtitles stream is enabled.
• public bool video_enabled { get; set; }
  Whether video stream is enabled.
• public Element video_filter { owned get; set; }
  Optional video filter to use (none by default).
• public Element video_sink { owned get; set; }
  Video sink to use (autovideosink by default).
• public StreamList video_streams { get; }
  List of currently available video streams.
• public double volume { get; set; }
  Current volume as a decimal number (1.0 = 100%).

Creation methods:

• public Player ()
  Creates a new Player instance.

Methods:

• public void add_feature (Feature feature)
  Add another Feature to the player.
• public void advance_frame ()
  Request the player to perform a frame step operation.
• public uint get_adaptive_bandwidth ()
  Get last fragment download bandwidth (bits/s) during adaptive streaming.
• public uint get_adaptive_max_bitrate ()
  Get currently set maximal bitrate (bits/s) for adaptive streaming.
• public uint get_adaptive_min_bitrate ()
  Get currently set minimal bitrate (bits/s) for adaptive streaming.
• public uint get_adaptive_start_bitrate ()
  Get currently set initial bitrate (bits/s) for adaptive streaming.
• public bool get_audio_enabled ()
  Get whether audio stream is enabled.
• public Element get_audio_filter ()
  Get Element used as audio filter.
• public double get_audio_offset ()
  Get the currently set audio stream offset.
• public Element get_audio_sink ()
  Get Element used as audio sink.
• public unowned StreamList get_audio_streams ()
  Get a list of audio streams within media item.
• public bool get_autoplay ()
  Get the autoplay value.
• public Element get_current_audio_decoder ()
  Get Element currently used as audio decoder.
• public Element get_current_video_decoder ()
  Get Element currently used as video decoder.
• public string? get_download_dir ()
  Get path to a directory set for media downloads.
• public bool get_download_enabled ()
  Get whether progressive download buffering is enabled.
• public unowned EnhancerProxyList get_enhancer_proxies ()
  Get a list of available enhancers in the form of [class@Clapper.
• public bool get_mute ()
  Get the mute state of the player.
• public double get_position ()
  Get the current player playback position.
• public unowned Queue get_queue ()
  Get the Queue of the player.
• public double get_speed ()
  Get the speed of the player used for playback.
• public PlayerState get_state ()
  Get the current PlayerState.
• public string get_subtitle_font_desc ()
  Get the currently set font description used for subtitle stream rendering.
• public double get_subtitle_offset ()
  Get the currently set subtitle stream offset.
• public unowned StreamList get_subtitle_streams ()
  Get a list of subtitle streams within media item.
• public bool get_subtitles_enabled ()
  Get whether subtitles are to be shown when available.
• public bool get_video_enabled ()
  Get whether video stream is enabled.
• public Element get_video_filter ()
  Get Element used as video filter.
• public Element get_video_sink ()
  Get Element used as video sink.
• public unowned StreamList get_video_streams ()
  Get a list of video streams within media item.
• public double get_volume ()
  Get the volume of the player.
• public string make_pipeline_graph (DebugGraphDetails details)
  Make current GStreamer pipeline graph in `graphviz` dot format.
• public void pause ()
  Pause the playback of current media item.
• public void play ()
  Either start or resume the playback of current media item.
• public void post_message (owned Message msg, PlayerMessageDestination destination)
  Allows sending custom messages to the desired destination .
• public void seek (double position)
  Request the player to perform a seek operation.
• public void seek_custom (double position, PlayerSeekMethod method)
  Request the player to perform a seek operation.
• public void set_adaptive_max_bitrate (uint bitrate)
  Set maximal bitrate to select for adaptive streaming such as DASH or HLS.
• public void set_adaptive_min_bitrate (uint bitrate)
  Set minimal bitrate to select for adaptive streaming such as DASH or HLS.
• public void set_adaptive_start_bitrate (uint bitrate)
  Set initial bitrate to select when starting adaptive streaming such as DASH or HLS.
• public void set_audio_enabled (bool enabled)
  Set whether enable audio stream.
• public void set_audio_filter (Element? element)
  Set Element to be used as audio filter.
• public void set_audio_offset (double offset)
  Set synchronisation offset between the audio stream and video.
• public void set_audio_sink (Element? element)
  Set Element to be used as audio sink.
• public void set_autoplay (bool enabled)
  Set the autoplay state of the player.
• public void set_download_dir (string path)
  Set a directory that this will use to store downloads.
• public void set_download_enabled (bool enabled)
  Set whether player should attempt progressive download buffering.
• public void set_mute (bool mute)
  Set the mute state of the player.
• public void set_speed (double speed)
  Set the speed multiplier of the player.
• public void set_subtitle_font_desc (string font_desc)
  Set Pango font description to be used for subtitle stream rendering.
• public void set_subtitle_offset (double offset)
  Set synchronisation offset between the subtitle stream and video.
• public void set_subtitles_enabled (bool enabled)
  Set whether subtitles should be shown if any.
• public void set_video_enabled (bool enabled)
  Set whether enable video stream.
• public void set_video_filter (Element? element)
  Set Element to be used as video filter.
• public void set_video_sink (Element? element)
  Set Element to be used as video sink.
• public void set_volume (double volume)
  Set the volume of the player.
• public void stop ()
  Stop the playback of current media item.

Signals:

• public signal void download_complete (MediaItem item, string location)
  Media was fully downloaded to local cache directory.
• public signal void error (Error error, string? debug_info)
  These are normal error messages.
• public signal void message (Message msg)
  Allows for applications to receive element messages posted on the underlaying pipeline bus.
• public signal void missing_plugin (string name, string? installer_detail)
  A GStreamer plugin or one of its features needed for playback is missing.
• public signal void seek_done ()
  A seeking operation has finished.
• public signal void warning (Error error, string? debug_info)
  These are some usually more minor error messages that should be treated like warnings.

Inherited Members: