PlayBin (GStreamer 1.x Java Core 1.4.0 API)

java.lang.Object
- org.freedesktop.gstreamer.glib.NativeObject
- - org.freedesktop.gstreamer.glib.RefCountedObject
  - - org.freedesktop.gstreamer.glib.GObject
    - - org.freedesktop.gstreamer.GstObject
      - org.freedesktop.gstreamer.Element
        
        org.freedesktop.gstreamer.Bin
        
        org.freedesktop.gstreamer.Pipeline
        
        org.freedesktop.gstreamer.elements.PlayBin

All Implemented Interfaces:

AutoCloseable
```
public class PlayBin
extends Pipeline
```
Playbin provides a stand-alone everything-in-one abstraction for an audio and/or video player.
See upstream documentation at https://gstreamer.freedesktop.org/documentation/playback/playbin.html

It can handle both audio and video files and features
- automatic file type recognition and based on that automatic selection and usage of the right audio/video/subtitle demuxers/decoders
- visualisations for audio files
- subtitle support for video files. Subtitles can be store in external files.
- stream selection between different video/audio/subtitles streams
- meta info (tag) extraction
- easy access to the last video frame
- buffering when playing streams over a network
- volume control with mute option
playbin is a Pipeline. It will notify the application of everything that's happening (errors, end of stream, tags found, state changes, etc.) by posting messages on its Bus. The application needs to watch the bus.
Playback can be initiated by setting the playbin to PLAYING state using setState or play. Note that the state change will take place in the background in a separate thread, when the function returns playback is probably not happening yet and any errors might not have occured yet. Applications using playbin should ideally be written to deal with things completely asynchroneous.
When playback has finished (an EOS message has been received on the bus) or an error has occured (an ERROR message has been received on the bus) or the user wants to play a different track, playbin should be set back to READY or NULL state, then the input file/URI should be set to the new location and then playbin be set to PLAYING state again.
Seeking can be done using seek on the playbin element. Again, the seek will not be executed instantaneously, but will be done in a background thread. When the seek call returns the seek will most likely still be in process. An application may wait for the seek to finish (or fail) using Element.getState(long) with -1 as the timeout, but this will block the user interface and is not recommended at all.
Applications may query the current position and duration of the stream via Pipeline.queryPosition(java.util.concurrent.TimeUnit) and Pipeline.queryDuration(java.util.concurrent.TimeUnit) and setting the format passed to Format.TIME. If the query was successful, the duration or position will have been returned in units of nanoseconds.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PlayBin.ABOUT_TO_FINISH` Signal emitted when the current uri is about to finish.
`static interface`	`PlayBin.AUDIO_CHANGED` Signal is emitted whenever the number or order of the audio streams has changed.
`static interface`	`PlayBin.AUDIO_TAGS_CHANGED` Signal is emitted whenever the tags of an audio stream have changed.
`static interface`	`PlayBin.ELEMENT_SETUP` This signal is emitted when a new element is added to playbin or any of its sub-bins.
`static interface`	`PlayBin.SOURCE_SETUP` This signal is emitted after the source element has been created, so it can be configured by setting additional properties (e.g.
`static interface`	`PlayBin.TEXT_CHANGED` Signal is emitted whenever the number or order of the audio streams has changed.
`static interface`	`PlayBin.TEXT_TAGS_CHANGED` Signal is emitted whenever the tags of a text stream have changed.
`static interface`	`PlayBin.VIDEO_CHANGED` Signal is emitted whenever the number or order of the video streams has changed.
`static interface`	`PlayBin.VIDEO_TAGS_CHANGED` Signal is emitted whenever the tags of a video stream have changed.

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Bin
Bin.DebugGraphDetails, Bin.DEEP_ELEMENT_ADDED, Bin.DEEP_ELEMENT_REMOVED, Bin.DO_LATENCY, Bin.ELEMENT_ADDED, Bin.ELEMENT_REMOVED

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Element
Element.NO_MORE_PADS, Element.PAD_ADDED, Element.PAD_REMOVED

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject
GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject
NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields
Modifier and Type Field and Description

static String GST_NAME

static String GTYPE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`GST_NAME`
`static String`	`GTYPE_NAME`

Constructor Summary

Constructors
Constructor and Description

PlayBin(String name)
Creates a new PlayBin.

PlayBin(String name, URI uri)
Creates a new PlayBin.

Constructors
Constructor and Description
`PlayBin(String name)` Creates a new PlayBin.
`PlayBin(String name, URI uri)` Creates a new PlayBin.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect(PlayBin.ABOUT_TO_FINISH listener)` Adds a listener for the `about-to-finish` signal
`void`	`connect(PlayBin.AUDIO_CHANGED listener)` Adds a listener for the `audio-changed` signal
`void`	`connect(PlayBin.AUDIO_TAGS_CHANGED listener)` Adds a listener for the `audio-tags-changed` signal
`void`	`connect(PlayBin.ELEMENT_SETUP listener)` Add a listener for the `element-setup` signal.
`void`	`connect(PlayBin.SOURCE_SETUP listener)` Add a listener for the `source-setup` signal.
`void`	`connect(PlayBin.TEXT_CHANGED listener)` Adds a listener for the `audio-changed` signal
`void`	`connect(PlayBin.TEXT_TAGS_CHANGED listener)` Adds a listener for the `audio-tags-changed` signal
`void`	`connect(PlayBin.VIDEO_CHANGED listener)` Adds a listener for the `video-changed` signal
`void`	`connect(PlayBin.VIDEO_TAGS_CHANGED listener)` Adds a listener for the `video-tags-changed` signal
`void`	`disconnect(PlayBin.ABOUT_TO_FINISH listener)` Removes a listener for the `about-to-finish` signal
`void`	`disconnect(PlayBin.AUDIO_CHANGED listener)` Removes a listener for the `audio-changed` signal
`void`	`disconnect(PlayBin.AUDIO_TAGS_CHANGED listener)` Removes a listener for the `audio-tags-changed` signal
`void`	`disconnect(PlayBin.ELEMENT_SETUP listener)` Remove listener for the `element-setup` signal.
`void`	`disconnect(PlayBin.SOURCE_SETUP listener)` Remove listener for the `source-setup` signal.
`void`	`disconnect(PlayBin.TEXT_CHANGED listener)` Removes a listener for the `text-changed` signal
`void`	`disconnect(PlayBin.TEXT_TAGS_CHANGED listener)` Removes a listener for the `text-tags-changed` signal
`void`	`disconnect(PlayBin.VIDEO_CHANGED listener)` Removes a listener for the `video-changed` signal
`void`	`disconnect(PlayBin.VIDEO_TAGS_CHANGED listener)` Removes a listener for the `video-tags-changed` signal
`Pad`	`getAudioPad(int audioStreamIndex)` Retrieve the stream-combiner sinkpad for a specific text stream.
`TagList`	`getAudioTags(int audioStreamIndex)` Retrieve the tags of a specific audio stream number.
`int`	`getCurrentAudio()` Get the currently playing audio stream.
`int`	`getCurrentText()` Get the currently playing text stream.
`Set<PlayFlags>`	`getFlags()` Get the current flags set on this PlayBin.
`int`	`getNAudio()` Get the total number of available audio streams.
`int`	`getNText()` Get the total number of available text streams.
`Pad`	`getTextPad(int textStreamIndex)` Retrieve the stream-combiner sinkpad for a specific text stream.
`TagList`	`getTextTags(int textStreamIndex)` Retrieve the tags of a specific text stream number.
`double`	`getVolume()` Gets the current volume.
`void`	`setAudioSink(Element element)` Sets the audio output Element.
`void`	`setCurrentAudio(int n)` Set the currently playing audio stream.
`void`	`setCurrentText(int n)` Set the currently playing text stream.
`void`	`setFlags(Set<PlayFlags> flags)` Set the flags to control the behaviour of this PlayBin.
`void`	`setInputFile(File file)` Sets the media file to play.
`void`	`setTextSink(Element element)` Sets the text output Element.
`void`	`setURI(URI uri)` Sets the media URI to play.
`void`	`setVideoSink(Element element)` Sets the video output Element.
`void`	`setVisualization(Element element)` Sets the visualization output Element.
`void`	`setVolume(double volume)` Sets the audio playback volume.

Methods inherited from class org.freedesktop.gstreamer.Pipeline
getAutoFlushBus, getBus, getClock, queryDuration, queryDuration, queryPosition, queryPosition, querySegment, querySegment, seek, seek, seek, seek, setAutoFlushBus, setClock, useClock

Methods inherited from class org.freedesktop.gstreamer.Bin
add, addMany, connect, connect, connect, connect, connect, debugToDotFile, debugToDotFileWithTS, disconnect, disconnect, disconnect, disconnect, disconnect, getElementByName, getElementByNameRecurseUp, getElements, getElementsRecursive, getElementsSorted, getSinks, getSources, remove, removeMany

Methods inherited from class org.freedesktop.gstreamer.Element
addPad, connect, connect, connect, disconnect, disconnect, disconnect, getBaseTime, getContext, getFactory, getPads, getRequestPad, getSinkPads, getSrcPads, getStartTime, getState, getState, getState, getState, getStaticPad, isPlaying, link, linkFiltered, linkMany, linkPads, linkPadsFiltered, makeRawElement, pause, play, postMessage, query, ready, releaseRequestPad, removePad, seekSimple, sendEvent, setBaseTime, setCaps, setContext, setLockedState, setStartTime, setState, stop, syncStateWithParent, unlink, unlinkMany, unlinkPads

Methods inherited from class org.freedesktop.gstreamer.GstObject
addControlBinding, getAsString, getControlBinding, getName, getParent, hasActiveControlBindings, removeControlBinding, setAsString, setControlBindingDisabled, setControlBindingsDisabled, setName, suggestNextSync, syncValues, toString

Methods inherited from class org.freedesktop.gstreamer.glib.GObject
addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject
close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - GST_NAME
```
public static final String GST_NAME
```
    See Also:
    
    Constant Field Values
  - GTYPE_NAME
```
public static final String GTYPE_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PlayBin
```
public PlayBin(String name)
```
    Creates a new PlayBin.
    
    Parameters:
    
    name - The name used to identify this pipeline.
  - PlayBin
```
public PlayBin(String name,
               URI uri)
```
    Creates a new PlayBin.
    
    Parameters:
    
    name - The name used to identify this pipeline.
    
    uri - The URI of the media file to load.
- Method Detail
  - setInputFile
```
public void setInputFile(File file)
```
    Sets the media file to play.
    
    Parameters:
    
    file - The File to play.
  - setURI
```
public void setURI(URI uri)
```
    Sets the media URI to play.
    
    Parameters:
    
    uri - The URI to play.
  - setAudioSink
```
public void setAudioSink(Element element)
```
    Sets the audio output Element.
    To disable audio output, call this method with a null argument.
    
    Parameters:
    
    element - The element to use for audio output.
  - setVideoSink
```
public void setVideoSink(Element element)
```
    Sets the video output Element.
    To disable video output, call this method with a null argument.
    
    Parameters:
    
    element - The element to use for video output.
  - setTextSink
```
public void setTextSink(Element element)
```
    Sets the text output Element.
    To disable text output, call this method with a null argument.
    
    Parameters:
    
    element - The element to use for text output.
  - setVisualization
```
public void setVisualization(Element element)
```
    Sets the visualization output Element.
    
    Parameters:
    
    element - The element to use for visualization.
  - setFlags
```
public void setFlags(Set<PlayFlags> flags)
```
    Set the flags to control the behaviour of this PlayBin.
    The default value is soft-colorbalance+deinterlace+soft-volume+text+audio+video
    See individual PlayFlags value descriptions for more information.
    
    Parameters:
    
    flags - set of PlayFlags
  - getFlags
```
public Set<PlayFlags> getFlags()
```
    Get the current flags set on this PlayBin. The returned set will be writable so that it can be altered and passed back to setFlags(java.util.Set).
    
    Returns:
    
    set of current PlayFlags
  - setVolume
```
public void setVolume(double volume)
```
    Sets the audio playback volume.
    
    Parameters:
    
    volume - value between 0.0 and 1.0 with 1.0 being full volume.
  - getVolume
```
public double getVolume()
```
    Gets the current volume.
    
    Returns:
    
    The current volume as a percentage between 0 and 100 of the max volume.
  - getCurrentAudio
```
public int getCurrentAudio()
```
    Get the currently playing audio stream. By default the first audio stream with data is played. Default value: -1
    
    Returns:
    
    the currently playing audio stream index (index is zero based).
  - setCurrentAudio
```
public void setCurrentAudio(int n)
```
    Set the currently playing audio stream. By default the first audio stream with data is played.
    
    Parameters:
    
    n - audio stream index to switch to (index is zero based).
  - getNAudio
```
public int getNAudio()
```
    Get the total number of available audio streams.
    
    Returns:
    
    total number of available audio streams
  - getAudioPad
```
public Pad getAudioPad(int audioStreamIndex)
```
    Retrieve the stream-combiner sinkpad for a specific text stream. This pad can be used for notifications of caps changes, stream-specific queries, etc.
    
    Parameters:
    
    audioStreamIndex - a text stream number
    
    Returns:
    
    a GstPad, or NULL when the stream number does not exist.
  - getAudioTags
```
public TagList getAudioTags(int audioStreamIndex)
```
    Retrieve the tags of a specific audio stream number. This information can be used to select a stream.
    
    Parameters:
    
    audioStreamIndex - an audio stream number
    
    Returns:
    
    a GstTagList with tags or null when the stream number does not exist.
  - getCurrentText
```
public int getCurrentText()
```
    Get the currently playing text stream. By default the first text stream with data is played. Default value: -1
    
    Returns:
    
    the currently playing text stream index (index is zero based).
  - setCurrentText
```
public void setCurrentText(int n)
```
    Set the currently playing text stream. By default the first text stream with data is played.
    
    Parameters:
    
    n - text stream index to switch to (index is zero based).
  - getNText
```
public int getNText()
```
    Get the total number of available text streams.
    
    Returns:
    
    total number of available text streams
  - getTextPad
```
public Pad getTextPad(int textStreamIndex)
```
    Retrieve the stream-combiner sinkpad for a specific text stream. This pad can be used for notifications of caps changes, stream-specific queries, etc.
    
    Parameters:
    
    textStreamIndex - a text stream number
    
    Returns:
    
    a GstPad, or null when the stream number does not exist.
  - getTextTags
```
public TagList getTextTags(int textStreamIndex)
```
    Retrieve the tags of a specific text stream number. This information can be used to select a stream.
    
    Parameters:
    
    textStreamIndex - a text stream number
    
    Returns:
    
    a GstTagList with tags or null when the stream number does not exist.
  - connect
```
public void connect(PlayBin.ABOUT_TO_FINISH listener)
```
    Adds a listener for the about-to-finish signal
  - disconnect
```
public void disconnect(PlayBin.ABOUT_TO_FINISH listener)
```
    Removes a listener for the about-to-finish signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.VIDEO_CHANGED listener)
```
    Adds a listener for the video-changed signal
  - disconnect
```
public void disconnect(PlayBin.VIDEO_CHANGED listener)
```
    Removes a listener for the video-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.AUDIO_CHANGED listener)
```
    Adds a listener for the audio-changed signal
  - disconnect
```
public void disconnect(PlayBin.AUDIO_CHANGED listener)
```
    Removes a listener for the audio-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.TEXT_CHANGED listener)
```
    Adds a listener for the audio-changed signal
  - disconnect
```
public void disconnect(PlayBin.TEXT_CHANGED listener)
```
    Removes a listener for the text-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.VIDEO_TAGS_CHANGED listener)
```
    Adds a listener for the video-tags-changed signal
  - disconnect
```
public void disconnect(PlayBin.VIDEO_TAGS_CHANGED listener)
```
    Removes a listener for the video-tags-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.AUDIO_TAGS_CHANGED listener)
```
    Adds a listener for the audio-tags-changed signal
  - disconnect
```
public void disconnect(PlayBin.AUDIO_TAGS_CHANGED listener)
```
    Removes a listener for the audio-tags-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
public void connect(PlayBin.TEXT_TAGS_CHANGED listener)
```
    Adds a listener for the audio-tags-changed signal
  - disconnect
```
public void disconnect(PlayBin.TEXT_TAGS_CHANGED listener)
```
    Removes a listener for the text-tags-changed signal
    
    Parameters:
    
    listener - The listener that was previously added.
  - connect
```
@Gst.Since(minor=10)
public void connect(PlayBin.ELEMENT_SETUP listener)
```
    Add a listener for the element-setup signal.
    
    Parameters:
    
    listener - listener to add
  - disconnect
```
@Gst.Since(minor=10)
public void disconnect(PlayBin.ELEMENT_SETUP listener)
```
    Remove listener for the element-setup signal.
    
    Parameters:
    
    listener - listener to remove
  - connect
```
public void connect(PlayBin.SOURCE_SETUP listener)
```
    Add a listener for the source-setup signal.
    
    Parameters:
    
    listener - listener to add
  - disconnect
```
public void disconnect(PlayBin.SOURCE_SETUP listener)
```
    Remove listener for the source-setup signal.
    
    Parameters:
    
    listener - listener to remove

Class PlayBin

Nested Class Summary

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Bin

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Element

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.freedesktop.gstreamer.Pipeline

Methods inherited from class org.freedesktop.gstreamer.Bin

Methods inherited from class org.freedesktop.gstreamer.Element

Methods inherited from class org.freedesktop.gstreamer.GstObject

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

Methods inherited from class java.lang.Object

Field Detail

GST_NAME

GTYPE_NAME

Constructor Detail

PlayBin

PlayBin

Method Detail

setInputFile

setURI

setAudioSink

setVideoSink

setTextSink

setVisualization

setFlags

getFlags

setVolume

getVolume

getCurrentAudio

setCurrentAudio

getNAudio

getAudioPad

getAudioTags

getCurrentText

setCurrentText

getNText

getTextPad

getTextTags

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect

connect

disconnect