FileOutputOptions.Builder

Added in 1.1.0

Kotlin |Java

public final class FileOutputOptions.Builder

The builder of the FileOutputOptions object.

Summary

Public constructors
`Builder(@NonNull File file)` Creates a builder of the `FileOutputOptions` with a file object.

Public methods
`@NonNull FileOutputOptions`	`build()` Builds the `FileOutputOptions` instance.
`@NonNull B`	`setDurationLimitMillis(@IntRange(from = 0) long durationLimitMillis)` Sets the limit for the video duration in milliseconds.
`@NonNull B`	`setFileSizeLimit(@IntRange(from = 0) long fileSizeLimitBytes)` Sets the limit for the file length in bytes.
`@NonNull B`	`setLocation(@Nullable Location location)` Sets a `Location` object representing a geographic location where the video was recorded.

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull File file)

Creates a builder of the FileOutputOptions with a file object.

The file object can be created with a path using the File APIs. The path must be seekable and writable.

Parameters
`@NonNull File file`	the file object.

See also
`File`

Public methods

build

Added in 1.1.0

public @NonNull FileOutputOptions build()

Builds the FileOutputOptions instance.

setDurationLimitMillis

Added in 1.3.0

public @NonNull B setDurationLimitMillis(@IntRange(from = 0) long durationLimitMillis)

Sets the limit for the video duration in milliseconds.

When used to generate recording with Recorder, if the specified duration limit is reached while the recording is being recorded, the recording will be finalized with ERROR_DURATION_LIMIT_REACHED.

If not set or set with zero, the duration will be unlimited. If set with a negative value, an IllegalArgumentException will be thrown.

Parameters
`@IntRange(from = 0) long durationLimitMillis`	the video duration limit in milliseconds.

Returns
`@NonNull B`	this Builder.

Throws
`java.lang.IllegalArgumentException`	if the specified duration limit is negative.

setFileSizeLimit

Added in 1.1.0

public @NonNull B setFileSizeLimit(@IntRange(from = 0) long fileSizeLimitBytes)

Sets the limit for the file length in bytes.

When used with Recorder to generate recording, if the specified file size limit is reached while the recording is being recorded, the recording will be finalized with ERROR_FILE_SIZE_LIMIT_REACHED.

If not set or set with zero, the file size will be unlimited. If set with a negative value, an IllegalArgumentException will be thrown.

Parameters
`@IntRange(from = 0) long fileSizeLimitBytes`	the file size limit in bytes.

Returns
`@NonNull B`	this Builder.

Throws
`java.lang.IllegalArgumentException`	if the specified file size limit is negative.

setLocation

Added in 1.2.0

public @NonNull B setLocation(@Nullable Location location)

Sets a Location object representing a geographic location where the video was recorded.

When use with Recorder, the geographic location is stored in udta box if the output format is MP4, and is ignored for other formats. The geographic location is stored according to ISO-6709 standard.

If null, no location information will be saved with the video. Default value is null.

Throws
`java.lang.IllegalArgumentException`	if the latitude of the location is not in the range `[-90, 90]` or the longitude of the location is not in the range `[-180, 180]`.