Gst (GStreamer 1.x Java Core 1.4.0 API)

java.lang.Object
- org.freedesktop.gstreamer.Gst

```
public final class Gst
extends Object
```
Media library supporting arbitrary formats and filter graphs.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Gst.Since` Annotation on classes, methods or fields to show the required GStreamer version.
`static class`	`Gst.Types`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkVersion(int major, int minor)` Checks that the version of GStreamer requested in init() satisfies the given version or throws an exception.
`static void`	`deinit()` Clean up any resources created by GStreamer in `init(org.freedesktop.gstreamer.Version)`.
`static ScheduledExecutorService`	`getExecutor()` Gets the common `ScheduledExecutorService` used to execute background tasks and schedule timeouts.
`static GMainContext`	`getMainContext()` Gets the current main context used (if any).
`static Version`	`getVersion()` Gets the version of gstreamer currently available.
`static String`	`getVersionString()` Gets the the version of gstreamer currently in use, as a String.
`static void`	`init()` Initializes the GStreamer library.
`static String[]`	`init(String progname, String... args)` Initializes the GStreamer library.
`static void`	`init(Version requiredVersion)` Initializes the GStreamer library.
`static String[]`	`init(Version requestedVersion, String progname, String... args)` Initializes the GStreamer library.
`static void`	`invokeLater(Runnable task)` Schedules a task for execution on the gstreamer background `Executor`.
`static boolean`	`isInitialized()` Test whether the GStreamer library already initialized.
`static boolean`	`isSegTrapEnabled()` Some functions in the GStreamer core might install a custom SIGSEGV handler to better catch and report errors to the application.
`static void`	`main()` Waits for the gstreamer system to shutdown via a call to `quit`.
`static Bin`	`parseBinFromDescription(String binDescription, boolean ghostUnlinkedPads)` Creates a bin from a text bin description.
`static Bin`	`parseBinFromDescription(String binDescription, boolean ghostUnlinkedPads, List<GError> errors)` Creates a bin from a text bin description.
`static Element`	`parseLaunch(String pipelineDescription)` Create a new pipeline based on command line syntax.
`static Element`	`parseLaunch(String[] pipelineDescription)` Create a new element based on command line syntax.
`static Element`	`parseLaunch(String[] pipelineDescription, List<GError> errors)` Create a new element based on command line syntax.
`static Element`	`parseLaunch(String pipelineDescription, List<GError> errors)` Create a new pipeline based on command line syntax.
`static void`	`quit()` Signals the thread that called `init()` to return.
`static void`	`setSegTrap(boolean enabled)` Applications might want to disable/enable the SIGSEGV handling of the GStreamer core.
`static void`	`setUseDefaultContext(boolean useDefault)` Instructs gstreamer-java to use the default main context.
`static boolean`	`testVersion(int major, int minor)` Tests that the version of GStreamer requested in init() satisfies the given version.

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

- Method Detail
  - getVersion
```
public static Version getVersion()
```
    Gets the version of gstreamer currently available. This function can be used prior to calling init(org.freedesktop.gstreamer.Version)
    
    Returns:
    
    the version of gstreamer
  - getVersionString
```
public static String getVersionString()
```
    Gets the the version of gstreamer currently in use, as a String.
    
    Returns:
    
    a string representation of the version.
  - isSegTrapEnabled
```
public static boolean isSegTrapEnabled()
```
    Some functions in the GStreamer core might install a custom SIGSEGV handler to better catch and report errors to the application. Currently this feature is enabled by default when loading plugins.
    Applications might want to disable this behaviour with the setSegTrap(boolean) function. This is typically done if the application wants to install its own handler without GStreamer interfering.
    
    Returns:
    
    Segmentation Trap status.
  - setSegTrap
```
public static void setSegTrap(boolean enabled)
```
    Applications might want to disable/enable the SIGSEGV handling of the GStreamer core. See isSegTrapEnabled() for more information.
    
    Parameters:
    
    enabled -
  - isInitialized
```
public static final boolean isInitialized()
```
    Test whether the GStreamer library already initialized.
    
    Returns:
    
    true if the GStreamer library already initialized.
  - getExecutor
```
public static ScheduledExecutorService getExecutor()
```
    Gets the common ScheduledExecutorService used to execute background tasks and schedule timeouts.
    
    Returns:
    
    an executor that can be used for background tasks.
  - quit
```
public static void quit()
```
    Signals the thread that called init() to return.
  - parseLaunch
```
public static Element parseLaunch(String pipelineDescription,
                                  List<GError> errors)
```
    Create a new pipeline based on command line syntax. Please note that you might get a return value that is not NULL even though the error is set. In this case there was a recoverable parsing error and you can try to play the pipeline.
    
    Parameters:
    
    pipelineDescription - the command line describing the pipeline
    
    errors - a list that any errors will be added to
    
    Returns:
    
    a new element on success. If more than one top-level element is specified by the pipeline_description , all elements are put into a Pipeline, which then is returned.
    
    Throws:
    
    GstException - if the pipeline / element could not be created
  - parseLaunch
```
public static Element parseLaunch(String pipelineDescription)
```
    Create a new pipeline based on command line syntax. Please note that you might get a return value that is not NULL even though the error is set. In this case there was a recoverable parsing error and you can try to play the pipeline.
    
    Parameters:
    
    pipelineDescription - the command line describing the pipeline
    
    Returns:
    
    a new element on success. If more than one top-level element is specified by the pipeline_description , all elements are put into a Pipeline, which then is returned.
    
    Throws:
    
    GstException - if the pipeline / element could not be created
  - parseLaunch
```
public static Element parseLaunch(String[] pipelineDescription,
                                  List<GError> errors)
```
    Create a new element based on command line syntax. error will contain an error message if an erroneous pipeline is specified. An error does not mean that the pipeline could not be constructed.
    
    Parameters:
    
    pipelineDescription - An array of strings containing the command line describing the pipeline.
    
    errors - a list that any errors will be added to
    
    Returns:
    
    a new element on success.
    
    Throws:
    
    GstException - if the pipeline / element could not be created
  - parseLaunch
```
public static Element parseLaunch(String[] pipelineDescription)
```
    Create a new element based on command line syntax. error will contain an error message if an erroneous pipeline is specified. An error does not mean that the pipeline could not be constructed.
    
    Parameters:
    
    pipelineDescription - An array of strings containing the command line describing the pipeline.
    
    Returns:
    
    a new element on success.
    
    Throws:
    
    GstException - if the pipeline / element could not be created
  - parseBinFromDescription
```
public static Bin parseBinFromDescription(String binDescription,
                                          boolean ghostUnlinkedPads,
                                          List<GError> errors)
```
    Creates a bin from a text bin description. This function allows creation of a bin based on the syntax used in the gst-launch utillity.
    
    Parameters:
    
    binDescription - the command line describing the bin
    
    ghostUnlinkedPads - whether to create ghost pads for the bin from any unlinked pads
    
    errors - list that any errors will be added to
    
    Returns:
    
    The new Bin.
    
    Throws:
    
    GstException - if the bin could not be created
  - parseBinFromDescription
```
public static Bin parseBinFromDescription(String binDescription,
                                          boolean ghostUnlinkedPads)
```
    Creates a bin from a text bin description. This function allows creation of a bin based on the syntax used in the gst-launch utillity.
    
    Parameters:
    
    binDescription - the command line describing the bin
    
    ghostUnlinkedPads - whether to create ghost pads for the bin from any unlinked pads
    
    Returns:
    
    The new Bin.
    
    Throws:
    
    GstException - if the bin could not be created
  - main
```
public static void main()
```
    Waits for the gstreamer system to shutdown via a call to quit.
    For most gui programs, this is of little use. However, it can be a convenient way of keeping the main thread alive whilst gstreamer processing on other threads continues.
  - invokeLater
```
public static void invokeLater(Runnable task)
```
    Schedules a task for execution on the gstreamer background Executor.
    
    Parameters:
    
    task - the task to execute.
  - getMainContext
```
public static GMainContext getMainContext()
```
    Gets the current main context used (if any).
    
    Returns:
    
    a main context.
  - init
```
public static final void init()
                       throws GstException
```
    Initializes the GStreamer library.
    This is a shortcut if no arguments are to be passed to gstreamer.
    This is equivalent to calling init(org.freedesktop.gstreamer.Version) with Version.BASELINE, currently GStreamer 1.8. If you require features from a later version of GStreamer you should specify the required version.
    
    Throws:
    
    GstException
  - init
```
public static final void init(Version requiredVersion)
                       throws GstException
```
    Initializes the GStreamer library.
    This is a shortcut if no arguments are to be passed to gstreamer.
    
    Parameters:
    
    requiredVersion -
    
    Throws:
    
    GstException
  - init
```
public static final String[] init(String progname,
                                  String... args)
                           throws GstException
```
    Initializes the GStreamer library.
    This sets up internal path lists, registers built-in elements, and loads standard plugins.
    This is equivalent to calling init(org.freedesktop.gstreamer.Version, java.lang.String, java.lang.String...) with Version.BASELINE, currently GStreamer 1.8. If you require features from a later version of GStreamer you should specify the required version.
    
    Parameters:
    
    progname - the java program name.
    
    args - the java argument list.
    
    Returns:
    
    the list of arguments with any gstreamer specific options stripped out.
    
    Throws:
    
    GstException
  - init
```
public static final String[] init(Version requestedVersion,
                                  String progname,
                                  String... args)
                           throws GstException
```
    Initializes the GStreamer library.
    This sets up internal path lists, registers built-in elements, and loads standard plugins.
    
    Parameters:
    
    requestedVersion - the minimum requested GStreamer version.
    
    progname - the java program name.
    
    args - the java argument list.
    
    Returns:
    
    the list of arguments with any gstreamer specific options stripped out.
    
    Throws:
    
    GstException
  - deinit
```
public static final void deinit()
```
    Clean up any resources created by GStreamer in init(org.freedesktop.gstreamer.Version). It is normally not needed to call this function in a normal application as the resources will automatically be freed when the program terminates. This function is therefore mostly used by testsuites and other memory profiling tools. After this call GStreamer (including this method) should not be used anymore.
  - setUseDefaultContext
```
public static void setUseDefaultContext(boolean useDefault)
```
    Instructs gstreamer-java to use the default main context.
    This may be useful if integration with the GTK main loop is desirable, as all Bus signals and timers will be executed in the context of the GTK main loop.
    For the majority of programs though, it is better to wrap the individual listeners in a proxy which executes the listener in the appropriate context.
    
    Parameters:
    
    useDefault - if true, use the default glib main context.
  - checkVersion
```
public static void checkVersion(int major,
                                int minor)
```
    Checks that the version of GStreamer requested in init() satisfies the given version or throws an exception.
    
    Parameters:
    
    major - major version, only 1 is supported
    
    minor - minor version required
    
    Throws:
    
    GstException - if the requested version support was not requested
  - testVersion
```
public static boolean testVersion(int major,
                                  int minor)
```
    Tests that the version of GStreamer requested in init() satisfies the given version.
    
    Parameters:
    
    major - major version, only 1 is supported
    
    minor - minor version required
    
    Returns:
    
    boolean whether the version requirement can be satisfied

Class Gst

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getVersion

getVersionString

isSegTrapEnabled

setSegTrap

isInitialized

getExecutor

quit

parseLaunch

parseLaunch

parseLaunch

parseLaunch

parseBinFromDescription

parseBinFromDescription

main

invokeLater

getMainContext

init

init

init

init

deinit

setUseDefaultContext

checkVersion

testVersion