gnu.javax.sound.sampled.gstreamer.lines

Class GstPipeline


public class GstPipeline
extends Object

This class represent a GStreamer pipeline and is resposible to handle the flow of data to and from the GStreamer native backend.

Nested Class Summary

static class
GstPipeline.State

Field Summary

protected Preferences
prefs

Constructor Summary

GstPipeline()
Creates a new GstPipeline with a capacity of GstDataLine.DEFAULT_BUFFER_SIZE.
GstPipeline(int bufferSize)
Creates a new GstPipeline with a capacity of bufferSize.

Method Summary

int
available()
void
close()
Closes this pipeline.
void
createForWrite()
Creates a source pipeline.
void
drain()
Wait for remaining data to be enqueued in the pipeline.
void
flush()
Flush all the data currently waiting to be processed.
Pointer
getNativeClass()
Return a reference to the GstPipeline native class as a Pointer object.
GstPipeline.State
getState()
int
read(byte[] buffer, int offset, int length)
void
setState(GstPipeline.State state)
int
write(byte[] buffer, int offset, int length)
Write length bytes from the given buffer into this pipeline, starting at offset.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

prefs

protected Preferences prefs

Constructor Details

GstPipeline

public GstPipeline()
Creates a new GstPipeline with a capacity of GstDataLine.DEFAULT_BUFFER_SIZE.

GstPipeline

public GstPipeline(int bufferSize)
Creates a new GstPipeline with a capacity of bufferSize.

Method Details

available

public int available()

close

public void close()
Closes this pipeline. Short hand for #setState(State.STOP).

createForWrite

public void createForWrite()
            throws LineUnavailableException
Creates a source pipeline. A source pipeline is a pipe you send data for processing using the write method.

drain

public void drain()
Wait for remaining data to be enqueued in the pipeline.

flush

public void flush()
Flush all the data currently waiting to be processed.

getNativeClass

public Pointer getNativeClass()
Return a reference to the GstPipeline native class as a Pointer object. This method is intended as an helper accessor and the returned pointer needs to be casted and used in the native code only.
Returns:
Pointer to the native GstPipeline class.

getState

public GstPipeline.State getState()
Returns:
the state

read

public int read(byte[] buffer,
                int offset,
                int length)

setState

public void setState(GstPipeline.State state)
Parameters:
state - the state to set

write

public int write(byte[] buffer,
                 int offset,
                 int length)
Write length bytes from the given buffer into this pipeline, starting at offset. This method block if the pipeline can't accept more data.
Parameters:
buffer -
offset -
length -
Returns:

GstPipeline.java -- Represents a Gstreamer Pipeline. Copyright (C) 2007 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.