EditingEndedEvent

public final class EditingEndedEvent
extends Event implements Parcelable

java.lang.Object
   ↳ android.media.metrics.Event
     ↳ android.media.metrics.EditingEndedEvent

Event for an editing operation having ended.

Summary

Nested classes

class EditingEndedEvent.Builder

Builder for EditingEndedEvent 

Constants

int ERROR_CODE_AUDIO_PROCESSING_FAILED

Caused by an audio processing failure.

int ERROR_CODE_DECODER_INIT_FAILED

Caused by a decoder initialization failure.

int ERROR_CODE_DECODING_FAILED

Caused by a failure while trying to decode media samples.

int ERROR_CODE_DECODING_FORMAT_UNSUPPORTED

Caused by trying to decode content whose format is not supported.

int ERROR_CODE_ENCODER_INIT_FAILED

Caused by an encoder initialization failure.

int ERROR_CODE_ENCODING_FAILED

Caused by a failure while trying to encode media samples.

int ERROR_CODE_ENCODING_FORMAT_UNSUPPORTED

Caused by trying to encode content whose format is not supported.

int ERROR_CODE_FAILED_RUNTIME_CHECK

Error code for unexpected runtime errors.

int ERROR_CODE_IO_BAD_HTTP_STATUS

Caused by an HTTP server returning an unexpected HTTP response status code.

int ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED

Caused by failing to load data via cleartext HTTP, when the app's network security configuration does not permit it.

int ERROR_CODE_IO_FILE_NOT_FOUND

Caused by a non-existent file.

int ERROR_CODE_IO_NETWORK_CONNECTION_FAILED

Error code for network connection failures.

int ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT

Error code for network timeouts.

int ERROR_CODE_IO_NO_PERMISSION

Caused by lack of permission to perform an IO operation.

int ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE

Caused by reading data out of the data bounds.

int ERROR_CODE_IO_UNSPECIFIED

Error code for non-specific errors during input/output.

int ERROR_CODE_MUXING_FAILED

Caused by a failure while muxing media samples.

int ERROR_CODE_NONE

Special value representing that no error occurred.

int ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED

Caused by a video frame processing failure.

int FINAL_STATE_CANCELED

The editing operation was canceled.

int FINAL_STATE_ERROR

The editing operation failed due to an error.

int FINAL_STATE_SUCCEEDED

The editing operation was successful.

long OPERATION_TYPE_AUDIO_EDIT

Input audio was edited.

long OPERATION_TYPE_AUDIO_TRANSCODE

Input audio was decoded and re-encoded.

long OPERATION_TYPE_AUDIO_TRANSMUX

Input audio samples were written (muxed) directly to the output file without transcoding.

long OPERATION_TYPE_PAUSED

The editing operation was paused before it completed.

long OPERATION_TYPE_RESUMED

The editing operation resumed a previous (paused) operation.

long OPERATION_TYPE_VIDEO_EDIT

Input video was edited.

long OPERATION_TYPE_VIDEO_TRANSCODE

Input video was decoded and re-encoded.

long OPERATION_TYPE_VIDEO_TRANSMUX

Input video samples were written (muxed) directly to the output file without transcoding.

int PROGRESS_PERCENT_UNKNOWN

Special value for unknown final progress.

int TIME_SINCE_CREATED_UNKNOWN

Special value for unknown time since creation.

Inherited constants

Fields

public static final Creator<EditingEndedEvent> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getErrorCode()

Returns the error code for a failed editing session.

String getExporterName()

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.

float getFinalProgressPercent()

Returns the progress of the editing operation in percent at the moment that it ended, or PROGRESS_PERCENT_UNKNOWN if unknown.

int getFinalState()

Returns the state of the editing session when it ended.

List<MediaItemInfo> getInputMediaItemInfos()

Gets information about the input media items, or an empty list if unspecified.

Bundle getMetricsBundle()

Gets metrics-related information that is not supported by dedicated methods.

String getMuxerName()

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.

long getOperationTypes()

Gets a set of flags describing the types of operations performed.

MediaItemInfo getOutputMediaItemInfo()

Gets information about the output media item, or null if unspecified.

long getTimeSinceCreatedMillis()

Gets the elapsed time since creating of the editing session, in milliseconds, or TIME_SINCE_CREATED_UNKNOWN if unknown.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

ERROR_CODE_AUDIO_PROCESSING_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_AUDIO_PROCESSING_FAILED

Caused by an audio processing failure.

Constant Value: 18 (0x00000012)

ERROR_CODE_DECODER_INIT_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_DECODER_INIT_FAILED

Caused by a decoder initialization failure.

Constant Value: 11 (0x0000000b)

ERROR_CODE_DECODING_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_DECODING_FAILED

Caused by a failure while trying to decode media samples.

Constant Value: 12 (0x0000000c)

ERROR_CODE_DECODING_FORMAT_UNSUPPORTED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_DECODING_FORMAT_UNSUPPORTED

Caused by trying to decode content whose format is not supported.

Constant Value: 13 (0x0000000d)

ERROR_CODE_ENCODER_INIT_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_ENCODER_INIT_FAILED

Caused by an encoder initialization failure.

Constant Value: 14 (0x0000000e)

ERROR_CODE_ENCODING_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_ENCODING_FAILED

Caused by a failure while trying to encode media samples.

Constant Value: 15 (0x0000000f)

ERROR_CODE_ENCODING_FORMAT_UNSUPPORTED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_ENCODING_FORMAT_UNSUPPORTED

Caused by trying to encode content whose format is not supported.

Constant Value: 16 (0x00000010)

ERROR_CODE_FAILED_RUNTIME_CHECK

Added in Android VanillaIceCream 
public static final int ERROR_CODE_FAILED_RUNTIME_CHECK

Error code for unexpected runtime errors.

Constant Value: 2 (0x00000002)

ERROR_CODE_IO_BAD_HTTP_STATUS

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_BAD_HTTP_STATUS

Caused by an HTTP server returning an unexpected HTTP response status code.

Constant Value: 6 (0x00000006)

ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED

Caused by failing to load data via cleartext HTTP, when the app's network security configuration does not permit it.

Constant Value: 9 (0x00000009)

ERROR_CODE_IO_FILE_NOT_FOUND

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_FILE_NOT_FOUND

Caused by a non-existent file.

Constant Value: 7 (0x00000007)

ERROR_CODE_IO_NETWORK_CONNECTION_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_NETWORK_CONNECTION_FAILED

Error code for network connection failures.

Constant Value: 4 (0x00000004)

ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT

Error code for network timeouts.

Constant Value: 5 (0x00000005)

ERROR_CODE_IO_NO_PERMISSION

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_NO_PERMISSION

Caused by lack of permission to perform an IO operation. For example, lack of permission to access internet or external storage.

Constant Value: 8 (0x00000008)

ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE

Caused by reading data out of the data bounds.

Constant Value: 10 (0x0000000a)

ERROR_CODE_IO_UNSPECIFIED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_IO_UNSPECIFIED

Error code for non-specific errors during input/output.

Constant Value: 3 (0x00000003)

ERROR_CODE_MUXING_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_MUXING_FAILED

Caused by a failure while muxing media samples.

Constant Value: 19 (0x00000013)

ERROR_CODE_NONE

Added in Android VanillaIceCream 
public static final int ERROR_CODE_NONE

Special value representing that no error occurred.

Constant Value: 1 (0x00000001)

ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED

Added in Android VanillaIceCream 
public static final int ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED

Caused by a video frame processing failure.

Constant Value: 17 (0x00000011)

FINAL_STATE_CANCELED

Added in Android VanillaIceCream 
public static final int FINAL_STATE_CANCELED

The editing operation was canceled.

Constant Value: 2 (0x00000002)

FINAL_STATE_ERROR

Added in Android VanillaIceCream 
public static final int FINAL_STATE_ERROR

The editing operation failed due to an error.

Constant Value: 3 (0x00000003)

FINAL_STATE_SUCCEEDED

Added in Android VanillaIceCream 
public static final int FINAL_STATE_SUCCEEDED

The editing operation was successful.

Constant Value: 1 (0x00000001)

OPERATION_TYPE_AUDIO_EDIT

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_AUDIO_EDIT

Input audio was edited.

Constant Value: 8 (0x0000000000000008)

OPERATION_TYPE_AUDIO_TRANSCODE

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_AUDIO_TRANSCODE

Input audio was decoded and re-encoded.

Constant Value: 2 (0x0000000000000002)

OPERATION_TYPE_AUDIO_TRANSMUX

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_AUDIO_TRANSMUX

Input audio samples were written (muxed) directly to the output file without transcoding.

Constant Value: 32 (0x0000000000000020)

OPERATION_TYPE_PAUSED

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_PAUSED

The editing operation was paused before it completed.

Constant Value: 64 (0x0000000000000040)

OPERATION_TYPE_RESUMED

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_RESUMED

The editing operation resumed a previous (paused) operation.

Constant Value: 128 (0x0000000000000080)

OPERATION_TYPE_VIDEO_EDIT

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_VIDEO_EDIT

Input video was edited.

Constant Value: 4 (0x0000000000000004)

OPERATION_TYPE_VIDEO_TRANSCODE

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_VIDEO_TRANSCODE

Input video was decoded and re-encoded.

Constant Value: 1 (0x0000000000000001)

OPERATION_TYPE_VIDEO_TRANSMUX

Added in Android VanillaIceCream 
public static final long OPERATION_TYPE_VIDEO_TRANSMUX

Input video samples were written (muxed) directly to the output file without transcoding.

Constant Value: 16 (0x0000000000000010)

PROGRESS_PERCENT_UNKNOWN

Added in Android VanillaIceCream 
public static final int PROGRESS_PERCENT_UNKNOWN

Special value for unknown final progress.

Constant Value: -1 (0xffffffff)

TIME_SINCE_CREATED_UNKNOWN

Added in Android VanillaIceCream 
public static final int TIME_SINCE_CREATED_UNKNOWN

Special value for unknown time since creation.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in Android VanillaIceCream 
public static final Creator<EditingEndedEvent> CREATOR

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public boolean equals (Object o)

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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
o Object: This value may be null.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getExporterName

public String getExporterName ()

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.

Returns
String

getFinalProgressPercent

public float getFinalProgressPercent ()

Returns the progress of the editing operation in percent at the moment that it ended, or PROGRESS_PERCENT_UNKNOWN if unknown.

Returns
float

getFinalState

public int getFinalState ()

Returns the state of the editing session when it ended.

Returns
int Value is FINAL_STATE_SUCCEEDED, FINAL_STATE_CANCELED, or FINAL_STATE_ERROR

getInputMediaItemInfos

public List<MediaItemInfo> getInputMediaItemInfos ()

Gets information about the input media items, or an empty list if unspecified.

Returns
List<MediaItemInfo> This value cannot be null.

getMetricsBundle

public Bundle getMetricsBundle ()

Gets metrics-related information that is not supported by dedicated methods.

It is intended to be used for backwards compatibility by the metrics infrastructure.

Returns
Bundle This value cannot be null.

getMuxerName

public String getMuxerName ()

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.

Returns
String

getOperationTypes

public long getOperationTypes ()

Gets a set of flags describing the types of operations performed.

Returns
long Value is either 0 or a combination of OPERATION_TYPE_VIDEO_TRANSCODE, OPERATION_TYPE_AUDIO_TRANSCODE, OPERATION_TYPE_VIDEO_EDIT, OPERATION_TYPE_AUDIO_EDIT, OPERATION_TYPE_VIDEO_TRANSMUX, OPERATION_TYPE_AUDIO_TRANSMUX, OPERATION_TYPE_PAUSED, and OPERATION_TYPE_RESUMED

getOutputMediaItemInfo

public MediaItemInfo getOutputMediaItemInfo ()

Gets information about the output media item, or null if unspecified.

Returns
MediaItemInfo

getTimeSinceCreatedMillis

public long getTimeSinceCreatedMillis ()

Gets the elapsed time since creating of the editing session, in milliseconds, or TIME_SINCE_CREATED_UNKNOWN if unknown.

Returns
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

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES