EditingEndedEvent
class EditingEndedEvent : Event, Parcelable
| kotlin.Any | ||
| ↳ | android.media.metrics.Event | |
| ↳ | android.media.metrics.EditingEndedEvent | |
Event for an editing operation having ended.
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| Constants | |
|---|---|
| static Int |
Caused by an audio processing failure. |
| static Int |
Caused by a decoder initialization failure. |
| static Int |
Caused by a failure while trying to decode media samples. |
| static Int |
Caused by trying to decode content whose format is not supported. |
| static Int |
Caused by an encoder initialization failure. |
| static Int |
Caused by a failure while trying to encode media samples. |
| static Int |
Caused by trying to encode content whose format is not supported. |
| static Int |
Error code for unexpected runtime errors. |
| static Int |
Caused by an HTTP server returning an unexpected HTTP response status code. |
| static Int |
Caused by failing to load data via cleartext HTTP, when the app's network security configuration does not permit it. |
| static Int |
Caused by a non-existent file. |
| static Int |
Error code for network connection failures. |
| static Int |
Error code for network timeouts. |
| static Int |
Caused by lack of permission to perform an IO operation. |
| static Int |
Caused by reading data out of the data bounds. |
| static Int |
Error code for non-specific errors during input/output. |
| static Int |
Caused by a failure while muxing media samples. |
| static Int |
Special value representing that no error occurred. |
| static Int |
Caused by a video frame processing failure. |
| static Int |
The editing operation was canceled. |
| static Int |
The editing operation failed due to an error. |
| static Int |
The editing operation was successful. |
| static Long |
Input audio was edited. |
| static Long |
Input audio was decoded and re-encoded. |
| static Long |
Input audio samples were written (muxed) directly to the output file without transcoding. |
| static Long |
The editing operation was paused before it completed. |
| static Long |
The editing operation resumed a previous (paused) operation. |
| static Long |
Input video was edited. |
| static Long |
Input video was decoded and re-encoded. |
| static Long |
Input video samples were written (muxed) directly to the output file without transcoding. |
| static Int |
Special value for unknown final progress. |
| static Int |
Special value for unknown time since creation. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
Returns the error code for a failed editing session. |
| String? |
Returns the name of the library implementing the exporting operation, for example, a Maven artifact ID like "androidx. |
| Float |
Returns the progress of the editing operation in percent at the moment that it ended, or |
| Int |
Returns the state of the editing session when it ended. |
| MutableList<MediaItemInfo!> |
Gets information about the input media items, or an empty list if unspecified. |
| Bundle |
Gets metrics-related information that is not supported by dedicated methods. |
| String? |
Returns the name of the library implementing the media muxing operation, for example, a Maven artifact ID like "androidx. |
| Long |
Gets a set of flags describing the types of operations performed. |
| MediaItemInfo? |
Gets information about the output media item, or |
| Long |
Gets the elapsed time since creating of the editing session, in milliseconds, or |
| Int |
hashCode() |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<EditingEndedEvent!> | |
Constants
ERROR_CODE_AUDIO_PROCESSING_FAILED
static val ERROR_CODE_AUDIO_PROCESSING_FAILED: Int
Caused by an audio processing failure.
Value: 18
ERROR_CODE_DECODER_INIT_FAILED
static val ERROR_CODE_DECODER_INIT_FAILED: Int
Caused by a decoder initialization failure.
Value: 11
ERROR_CODE_DECODING_FAILED
static val ERROR_CODE_DECODING_FAILED: Int
Caused by a failure while trying to decode media samples.
Value: 12
ERROR_CODE_DECODING_FORMAT_UNSUPPORTED
static val ERROR_CODE_DECODING_FORMAT_UNSUPPORTED: Int
Caused by trying to decode content whose format is not supported.
Value: 13
ERROR_CODE_ENCODER_INIT_FAILED
static val ERROR_CODE_ENCODER_INIT_FAILED: Int
Caused by an encoder initialization failure.
Value: 14
ERROR_CODE_ENCODING_FAILED
static val ERROR_CODE_ENCODING_FAILED: Int
Caused by a failure while trying to encode media samples.
Value: 15
ERROR_CODE_ENCODING_FORMAT_UNSUPPORTED
static val ERROR_CODE_ENCODING_FORMAT_UNSUPPORTED: Int
Caused by trying to encode content whose format is not supported.
Value: 16
ERROR_CODE_FAILED_RUNTIME_CHECK
static val ERROR_CODE_FAILED_RUNTIME_CHECK: Int
Error code for unexpected runtime errors.
Value: 2
ERROR_CODE_IO_BAD_HTTP_STATUS
static val ERROR_CODE_IO_BAD_HTTP_STATUS: Int
Caused by an HTTP server returning an unexpected HTTP response status code.
Value: 6
ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED
static val ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED: Int
Caused by failing to load data via cleartext HTTP, when the app's network security configuration does not permit it.
Value: 9
ERROR_CODE_IO_FILE_NOT_FOUND
static val ERROR_CODE_IO_FILE_NOT_FOUND: Int
Caused by a non-existent file.
Value: 7
ERROR_CODE_IO_NETWORK_CONNECTION_FAILED
static val ERROR_CODE_IO_NETWORK_CONNECTION_FAILED: Int
Error code for network connection failures.
Value: 4
ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT
static val ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT: Int
Error code for network timeouts.
Value: 5
ERROR_CODE_IO_NO_PERMISSION
static val ERROR_CODE_IO_NO_PERMISSION: Int
Caused by lack of permission to perform an IO operation. For example, lack of permission to access internet or external storage.
Value: 8
ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE
static val ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE: Int
Caused by reading data out of the data bounds.
Value: 10
ERROR_CODE_IO_UNSPECIFIED
static val ERROR_CODE_IO_UNSPECIFIED: Int
Error code for non-specific errors during input/output.
Value: 3
ERROR_CODE_MUXING_FAILED
static val ERROR_CODE_MUXING_FAILED: Int
Caused by a failure while muxing media samples.
Value: 19
ERROR_CODE_NONE
static val ERROR_CODE_NONE: Int
Special value representing that no error occurred.
Value: 1
ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED
static val ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED: Int
Caused by a video frame processing failure.
Value: 17
FINAL_STATE_CANCELED
static val FINAL_STATE_CANCELED: Int
The editing operation was canceled.
Value: 2
FINAL_STATE_ERROR
static val FINAL_STATE_ERROR: Int
The editing operation failed due to an error.
Value: 3
FINAL_STATE_SUCCEEDED
static val FINAL_STATE_SUCCEEDED: Int
The editing operation was successful.
Value: 1
OPERATION_TYPE_AUDIO_EDIT
static val OPERATION_TYPE_AUDIO_EDIT: Long
Input audio was edited.
Value: 8L
OPERATION_TYPE_AUDIO_TRANSCODE
static val OPERATION_TYPE_AUDIO_TRANSCODE: Long
Input audio was decoded and re-encoded.
Value: 2L
OPERATION_TYPE_AUDIO_TRANSMUX
static val OPERATION_TYPE_AUDIO_TRANSMUX: Long
Input audio samples were written (muxed) directly to the output file without transcoding.
Value: 32L
OPERATION_TYPE_PAUSED
static val OPERATION_TYPE_PAUSED: Long
The editing operation was paused before it completed.
Value: 64L
OPERATION_TYPE_RESUMED
static val OPERATION_TYPE_RESUMED: Long
The editing operation resumed a previous (paused) operation.
Value: 128L
OPERATION_TYPE_VIDEO_EDIT
static val OPERATION_TYPE_VIDEO_EDIT: Long
Input video was edited.
Value: 4L
OPERATION_TYPE_VIDEO_TRANSCODE
static val OPERATION_TYPE_VIDEO_TRANSCODE: Long
Input video was decoded and re-encoded.
Value: 1L
OPERATION_TYPE_VIDEO_TRANSMUX
static val OPERATION_TYPE_VIDEO_TRANSMUX: Long
Input video samples were written (muxed) directly to the output file without transcoding.
Value: 16L
PROGRESS_PERCENT_UNKNOWN
static val PROGRESS_PERCENT_UNKNOWN: Int
Special value for unknown final progress.
Value: -1
TIME_SINCE_CREATED_UNKNOWN
static val TIME_SINCE_CREATED_UNKNOWN: Int
Special value for unknown time since creation.
Value: -1
Public methods
describeContents
fun describeContents(): Int
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getErrorCode
fun getErrorCode(): Int
Returns the error code for a failed editing session.
getExporterName
fun getExporterName(): String?
Returns the name of the library implementing the exporting operation, for example, a Maven artifact ID like "androidx.media3.media3-transformer:1.3.0-beta01", or null if unknown.
getFinalProgressPercent
fun getFinalProgressPercent(): Float
Returns the progress of the editing operation in percent at the moment that it ended, or PROGRESS_PERCENT_UNKNOWN if unknown.
getFinalState
fun getFinalState(): Int
Returns the state of the editing session when it ended.
getInputMediaItemInfos
fun getInputMediaItemInfos(): MutableList<MediaItemInfo!>
Gets information about the input media items, or an empty list if unspecified.
| Return | |
|---|---|
MutableList<MediaItemInfo!> |
This value cannot be null. |
getMetricsBundle
fun getMetricsBundle(): Bundle
Gets metrics-related information that is not supported by dedicated methods.
It is intended to be used for backwards compatibility by the metrics infrastructure.
| Return | |
|---|---|
Bundle |
This value cannot be null. |
getMuxerName
fun getMuxerName(): String?
Returns the name of the library implementing the media muxing operation, for example, a Maven artifact ID like "androidx.media3.media3-muxer:1.3.0-beta01", or null if unknown.
getOperationTypes
fun getOperationTypes(): Long
Gets a set of flags describing the types of operations performed.
getOutputMediaItemInfo
fun getOutputMediaItemInfo(): MediaItemInfo?
Gets information about the output media item, or null if unspecified.
getTimeSinceCreatedMillis
fun getTimeSinceCreatedMillis(): Long
Gets the elapsed time since creating of the editing session, in milliseconds, or TIME_SINCE_CREATED_UNKNOWN if unknown.
| Return | |
|---|---|
Long |
The elapsed time since creating the editing session, in milliseconds, or TIME_SINCE_CREATED_UNKNOWN if unknown. Value is TIME_SINCE_CREATED_UNKNOWN or greater |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
This value cannot be null. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |