OutputOptions


abstract class OutputOptions

Known direct subclasses
FileDescriptorOutputOptions

A class providing options for storing the result to a given file descriptor.

FileOutputOptions

A class providing options for storing the result to a given file.

MediaStoreOutputOptions

A class providing options for storing output to MediaStore.


Options for configuring output destination for generating a recording.

A PendingRecording can be generated with prepareRecording for different types of output destination, such as FileOutputOptions, FileDescriptorOutputOptions and MediaStoreOutputOptions.

Summary

Constants

const Int

Represents an unlimited duration.

const Int

Represents an unbound file size.

Public functions

@IntRange(from = 0) Long

Gets the limit for the video duration in milliseconds.

@IntRange(from = 0) Long

Gets the limit for the file size in bytes.

Location?

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

Constants

DURATION_UNLIMITED

Added in 1.3.0
const val DURATION_UNLIMITED = 0: Int

Represents an unlimited duration.

FILE_SIZE_UNLIMITED

Added in 1.1.0
const val FILE_SIZE_UNLIMITED = 0: Int

Represents an unbound file size.

Public functions

getDurationLimitMillis

Added in 1.3.0
fun getDurationLimitMillis(): @IntRange(from = 0) Long

Gets the limit for the video duration in milliseconds.

Returns
@IntRange(from = 0) Long

the video duration limit in milliseconds or DURATION_UNLIMITED if it's unlimited.

getFileSizeLimit

Added in 1.1.0
fun getFileSizeLimit(): @IntRange(from = 0) Long

Gets the limit for the file size in bytes.

Returns
@IntRange(from = 0) Long

the file size limit in bytes or FILE_SIZE_UNLIMITED if it's unlimited.

getLocation

Added in 1.2.0
fun getLocation(): Location?

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

Returns
Location?

the location object or null if no location was set.