transformerkt/dev.transformerkt.ktx.inputs/start

start

@CheckResult
fun Transformer.start(input: Composition, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Start a Transformer request for a Composition and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: Composition, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Start a Transformer request for a Composition in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: EditedMediaItem, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Start a Transformer request for a EditedMediaItem and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: EditedMediaItem, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Start a Transformer request for a EditedMediaItem in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: File, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Start a Transformer request for a File and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: File, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Start a Transformer request for a File in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: MediaItem, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Start a Transformer request for a MediaItem and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: MediaItem, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Start a Transformer request for a MediaItem in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: Uri, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Start a Transformer request for a Uri and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: Uri, output: File, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Start a Transformer request for a Uri in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: Composition, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a Composition and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: Composition, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs, onProgress)
Content copied to clipboard

Start a Transformer request for a Composition in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: EditedMediaItem, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a EditedMediaItem and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: EditedMediaItem, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs, onProgress)
Content copied to clipboard

Start a Transformer request for a EditedMediaItem in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: File, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a File and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: File, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs, onProgress)
Content copied to clipboard

Start a Transformer request for a File in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: MediaItem, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a MediaItem and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: MediaItem, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a MediaItem in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start
@CheckResult
fun Transformer.start(input: Uri, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS): Flow<TransformerStatus>

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs)
Content copied to clipboard

Start a Transformer request for a Uri and return a Flow of TransformerStatus.

Return

A Flow that emits TransformerStatus.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

See also

createTransformerCallbackFlow
suspend fun Transformer.start(input: Uri, output: File, request: TransformationRequest, progressPollDelayMs: Long = TransformerKt.DEFAULT_PROGRESS_POLL_DELAY_MS, onProgress: (Int) -> Unit = {}): TransformerStatus.Finished

Deprecated

Using TransformerRequest has been deprecated

Replace with

start(input, output, progressPollDelayMs, onProgress)
Content copied to clipboard

Start a Transformer request for a Uri in a coroutine and return a TransformerStatus.Finished when the request is finished.

For progress updates pass a onProgress callback.

Return

A TransformerStatus.Finished status.

Parameters

input

The input to transform.

output

The output file to write to.

request
progressPollDelayMs

The delay between polling for progress.

onProgress

The callback to use for progress updates.

See also

start