io.straas.android.sdk.streaming

Class StreamConfig.Builder

java.lang.Object

io.straas.android.sdk.streaming.StreamConfig.Builder

Enclosing class:

StreamConfig

public static class StreamConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StreamConfig	build()
StreamConfig.Builder	camera(int camera) Sets which is the default camera.
StreamConfig.Builder	fitAllCamera(boolean fitAllCamera) Sets if the final resolution should fit all camera in current device.
StreamConfig.Builder	fps(int fps) Sets the video frame rate in format frames/sec.
StreamConfig.Builder	frontCameraFlipHorizontally(boolean flip) If you enable this, you will stream the horizontally flipped screen of preview when you use the StreamConfig.CAMERA_FRONT.
StreamConfig.Builder	highestResolution(Resolution resolution) Deprecated. use maxVideoHeight(int)
StreamConfig.Builder	maxBitrate(Integer maxBitrate) Sets the maximum video bitrate in bits/sec.
StreamConfig.Builder	maxVideoHeight(int height) Sets the max video height in pixel, which the video height will be limited by.
StreamConfig.Builder	videoResolution(int width, int height) Sets video resolution for live stream, this means the resolution that audience can see.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

videoResolution

public StreamConfig.Builder videoResolution(int width,
                                            int height)

Sets video resolution for live stream, this means the resolution that audience can see. If you didn't call this method, output video size will be determined by aspect ratio of textureView sent by StreamManager.prepare(StreamConfig, TextureView).

Parameters:

width - video width

height - video height

See Also:

highestResolution(Resolution), fitAllCamera(boolean)

fitAllCamera

public StreamConfig.Builder fitAllCamera(boolean fitAllCamera)

Sets if the final resolution should fit all camera in current device.

This value is used when videoResolution(int, int)} is not called. The default value is true.

Parameters:

fitAllCamera - true if you to enable this.

highestResolution

@Deprecated
public StreamConfig.Builder highestResolution(Resolution resolution)

Deprecated. use maxVideoHeight(int)

Sets highest resolution, both width and height will be limited by this resolution. If the target resolution you set by videoResolution(int, int)} is bigger than this, the final resolution will be shrank to match the highest resolution with the sample aspect ratio.

The default value isResolution._720p.

Parameters:

resolution - highest resolution

maxVideoHeight

public StreamConfig.Builder maxVideoHeight(int height)
                                    throws IllegalArgumentException

Sets the max video height in pixel, which the video height will be limited by. The final video height will be limited by this value but still have the same aspect ratio.

This value is usually decided by the profile of the live event you want to stream to. For example, you should set the max video height to 360 if you want to stream to a live event with profile Profile._360P.

The default value 720 and min value is 240.

Parameters:

height - video height in pixel

Throws:

IllegalArgumentException - if the height is less than 240

camera

public StreamConfig.Builder camera(int camera)

Sets which is the default camera.

Parameters:

camera - see StreamConfig.CAMERA_TYPE

frontCameraFlipHorizontally

public StreamConfig.Builder frontCameraFlipHorizontally(boolean flip)

If you enable this, you will stream the horizontally flipped screen of preview when you use the StreamConfig.CAMERA_FRONT. So, the preview you watch and the video audiences watch won't the same. And the front camera always shows like a mirror. That means, the audiences won't see everything like a mirror. It helps when you want to let your audiences see the word. The default value is true.

Parameters:

flip - true if you want to enable this

fps

public StreamConfig.Builder fps(int fps)
                         throws IllegalArgumentException

Sets the video frame rate in format frames/sec. The default value is 30.

Parameters:

fps - video frame rate in format frames/sec, can only be 20 or 30

Throws:

IllegalArgumentException - if fps is invalid

maxBitrate

public StreamConfig.Builder maxBitrate(Integer maxBitrate)
                                throws IllegalArgumentException

Sets the maximum video bitrate in bits/sec. If you set this value to null or don't call this method, the SDK calculates the maximum bitrate automatically using an algorithm which considers the output video size. The minimum value is 100,000.

Parameters:

maxBitrate - the video bitrate in bits/sec

Throws:

IllegalArgumentException - if max bitrate if invalid

build

public StreamConfig build()