Package com.google.android.filament

Class Stream.Builder

java.lang.Object

com.google.android.filament.Stream.Builder

Enclosing class:

Stream

public static class Stream.Builder
extends java.lang.Object

Use Builder to construct an Stream object instance. By default, Stream objects are ACQUIRED and must have external images pushed to them via Stream.setAcquiredImage(java.lang.Object, java.lang.Object, java.lang.Runnable). To create a NATIVE stream, call the

stream

method on the builder.

Constructor Summary

Constructors

Constructor	Description
Builder()	Use Builder to construct an Stream object instance.

Method Summary

Modifier and Type	Method	Description
Stream	build(Engine engine)	Creates a new Stream object instance.
Stream.Builder	height(int height)
Stream.Builder	stream(java.lang.Object streamSource)	Creates a NATIVE stream.
Stream.Builder	width(int width)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Use Builder to construct an Stream object instance.

Method Detail

stream

@NonNull
public Stream.Builder stream(@NonNull
                             java.lang.Object streamSource)

Creates a NATIVE stream. Native streams can sample data directly from an opaque platform object such as a SurfaceTexture on Android.

Parameters:

streamSource - an opaque native stream handle, e.g.: on Android this must be a SurfaceTexture object

Returns:

This Builder, for chaining calls.

See Also:

Texture.setExternalStream(com.google.android.filament.Engine, com.google.android.filament.Stream)

width

@NonNull
public Stream.Builder width(int width)

Parameters:

width - initial width of the incoming stream. Whether this value is used is stream dependent. On Android, it must be set when using #stream(long)

Returns:

This Builder, for chaining calls.

height

@NonNull
public Stream.Builder height(int height)

Parameters:

height - initial height of the incoming stream. Whether this value is used is stream dependent. On Android, it must be set when using #stream(long)

Returns:

This Builder, for chaining calls.

build

@NonNull
public Stream build(@NonNull
                    Engine engine)

Creates a new Stream object instance.

Parameters:

engine - Engine instance to associate this Stream with.

Returns:

newly created Stream object

Throws:

java.lang.IllegalStateException - if the Stream couldn't be created