DebugTraceUtil

Kotlin |Java

@UnstableApi
class DebugTraceUtil

A debugging tracing utility. Debug logging is disabled at compile time by default.

Summary

Nested types
`@Documented @Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Target(value = ElementType.TYPE_USE) annotation DebugTraceUtil.Component` Components logged by logEvent.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @StringDef(value = ) @Target(value = ElementType.TYPE_USE) annotation DebugTraceUtil.Event` Events logged by logEvent.

Constants
`const String!`	`COMPONENT_ASSET_LOADER = "AssetLoader"`
`const String!`	`COMPONENT_AUDIO_DECODER = "AudioDecoder"`
`const String!`	`COMPONENT_AUDIO_ENCODER = "AudioEncoder"`
`const String!`	`COMPONENT_AUDIO_GRAPH = "AudioGraph"`
`const String!`	`COMPONENT_AUDIO_MIXER = "AudioMixer"`
`const String!`	`COMPONENT_BITMAP_TEXTURE_MANAGER = "BitmapTextureManager"`
`const String!`	`COMPONENT_COMPOSITION_PLAYER = "CompositionPlayer"`
`const String!`	`COMPONENT_COMPOSITOR = "Compositor"`
`const String!`	`COMPONENT_EXTERNAL_TEXTURE_MANAGER = "ExternalTextureManager"`
`const String!`	`COMPONENT_MUXER = "Muxer"`
`const String!`	`COMPONENT_TEX_ID_TEXTURE_MANAGER = "TexIdTextureManager"`
`const String!`	`COMPONENT_TRANSFORMER_INTERNAL = "TransformerInternal"`
`const String!`	`COMPONENT_VFP = "VideoFrameProcessor"`
`const String!`	`COMPONENT_VIDEO_DECODER = "VideoDecoder"`
`const String!`	`COMPONENT_VIDEO_ENCODER = "VideoEncoder"`
`const String!`	`EVENT_ACCEPTED_INPUT = "AcceptedInput"`
`const String!`	`EVENT_CAN_WRITE_SAMPLE = "CanWriteSample"`
`const String!`	`EVENT_INPUT_ENDED = "InputEnded"`
`const String!`	`EVENT_INPUT_FORMAT = "InputFormat"`
`const String!`	`EVENT_OUTPUT_ENDED = "OutputEnded"`
`const String!`	`EVENT_OUTPUT_FORMAT = "OutputFormat"`
`const String!`	`EVENT_OUTPUT_TEXTURE_RENDERED = "OutputTextureRendered"`
`const String!`	`EVENT_PRODUCED_OUTPUT = "ProducedOutput"`
`const String!`	`EVENT_QUEUE_BITMAP = "QueueBitmap"`
`const String!`	`EVENT_QUEUE_FRAME = "QueueFrame"`
`const String!`	`EVENT_QUEUE_TEXTURE = "QueueTexture"`
`const String!`	`EVENT_RECEIVE_END_OF_ALL_INPUT = "ReceiveEndOfAllInput"`
`const String!`	`EVENT_RECEIVE_EOS = "ReceiveEOS"`
`const String!`	`EVENT_REGISTER_NEW_INPUT_STREAM = "RegisterNewInputStream"`
`const String!`	`EVENT_RELEASE = "Release"`
`const String!`	`EVENT_RENDERED_TO_OUTPUT_SURFACE = "RenderedToOutputSurface"`
`const String!`	`EVENT_SEEK_TO = "SeekTo"`
`const String!`	`EVENT_SET_COMPOSITION = "SetComposition"`
`const String!`	`EVENT_SET_VIDEO_OUTPUT = "SetVideoOutput"`
`const String!`	`EVENT_SIGNAL_ENDED = "SignalEnded"`
`const String!`	`EVENT_SIGNAL_EOS = "SignalEOS"`
`const String!`	`EVENT_START = "Start"`
`const String!`	`EVENT_SURFACE_TEXTURE_INPUT = "SurfaceTextureInput"`
`const String!`	`EVENT_SURFACE_TEXTURE_TRANSFORM_FIX = "SurfaceTextureTransformFix"`

Public constructors
`DebugTraceUtil()`

Public functions
`synchronized java-static Unit`	`dumpTsv(writer: Writer!)` Dumps all the logged events to the `Writer` as tab separated values (tsv).
`synchronized java-static String!`	`generateTraceSummary()` Generate a summary of the logged events, containing the total number of times an event happened and the detailed log of a window of the oldest and newest events.
`synchronized java-static Unit`	`logCodecEvent( isDecoder: Boolean, isVideo: Boolean, @DebugTraceUtil.Event eventName: @DebugTraceUtil.Event String!, presentationTimeUs: Long, extraFormat: String!, extraArgs: Array<Any!>! )` Logs an `Event` for a codec, if debug logging is enabled.
`synchronized java-static Unit`	`logEvent( @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!, @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!, presentationTimeUs: Long )` Logs a new event, if debug logging is enabled.
`synchronized java-static Unit`	`logEvent( @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!, @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!, presentationTimeUs: Long, jsonObject: JSONObject! )`
`synchronized java-static Unit`	`logEvent( @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!, @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!, presentationTimeUs: Long, extraFormat: String!, extraArgs: Array<Any!>! )` Logs a new event, if debug logging is enabled.
`synchronized java-static Unit`	`reset()`

Public properties
`java-static Boolean`	`enableTracing` Whether to store tracing events for debug logging.

Constants

COMPONENT_ASSET_LOADER

const val COMPONENT_ASSET_LOADER = "AssetLoader": String!

COMPONENT_AUDIO_DECODER

const val COMPONENT_AUDIO_DECODER = "AudioDecoder": String!

COMPONENT_AUDIO_ENCODER

const val COMPONENT_AUDIO_ENCODER = "AudioEncoder": String!

COMPONENT_AUDIO_GRAPH

const val COMPONENT_AUDIO_GRAPH = "AudioGraph": String!

COMPONENT_AUDIO_MIXER

const val COMPONENT_AUDIO_MIXER = "AudioMixer": String!

COMPONENT_BITMAP_TEXTURE_MANAGER

const val COMPONENT_BITMAP_TEXTURE_MANAGER = "BitmapTextureManager": String!

COMPONENT_COMPOSITION_PLAYER

const val COMPONENT_COMPOSITION_PLAYER = "CompositionPlayer": String!

COMPONENT_COMPOSITOR

const val COMPONENT_COMPOSITOR = "Compositor": String!

COMPONENT_EXTERNAL_TEXTURE_MANAGER

const val COMPONENT_EXTERNAL_TEXTURE_MANAGER = "ExternalTextureManager": String!

COMPONENT_MUXER

const val COMPONENT_MUXER = "Muxer": String!

COMPONENT_TEX_ID_TEXTURE_MANAGER

const val COMPONENT_TEX_ID_TEXTURE_MANAGER = "TexIdTextureManager": String!

COMPONENT_TRANSFORMER_INTERNAL

const val COMPONENT_TRANSFORMER_INTERNAL = "TransformerInternal": String!

COMPONENT_VFP

const val COMPONENT_VFP = "VideoFrameProcessor": String!

COMPONENT_VIDEO_DECODER

const val COMPONENT_VIDEO_DECODER = "VideoDecoder": String!

COMPONENT_VIDEO_ENCODER

const val COMPONENT_VIDEO_ENCODER = "VideoEncoder": String!

EVENT_ACCEPTED_INPUT

const val EVENT_ACCEPTED_INPUT = "AcceptedInput": String!

EVENT_CAN_WRITE_SAMPLE

const val EVENT_CAN_WRITE_SAMPLE = "CanWriteSample": String!

EVENT_INPUT_ENDED

const val EVENT_INPUT_ENDED = "InputEnded": String!

EVENT_INPUT_FORMAT

const val EVENT_INPUT_FORMAT = "InputFormat": String!

EVENT_OUTPUT_ENDED

const val EVENT_OUTPUT_ENDED = "OutputEnded": String!

EVENT_OUTPUT_FORMAT

const val EVENT_OUTPUT_FORMAT = "OutputFormat": String!

EVENT_OUTPUT_TEXTURE_RENDERED

const val EVENT_OUTPUT_TEXTURE_RENDERED = "OutputTextureRendered": String!

EVENT_PRODUCED_OUTPUT

const val EVENT_PRODUCED_OUTPUT = "ProducedOutput": String!

EVENT_QUEUE_BITMAP

const val EVENT_QUEUE_BITMAP = "QueueBitmap": String!

EVENT_QUEUE_FRAME

const val EVENT_QUEUE_FRAME = "QueueFrame": String!

EVENT_QUEUE_TEXTURE

const val EVENT_QUEUE_TEXTURE = "QueueTexture": String!

EVENT_RECEIVE_END_OF_ALL_INPUT

const val EVENT_RECEIVE_END_OF_ALL_INPUT = "ReceiveEndOfAllInput": String!

EVENT_RECEIVE_EOS

const val EVENT_RECEIVE_EOS = "ReceiveEOS": String!

EVENT_REGISTER_NEW_INPUT_STREAM

const val EVENT_REGISTER_NEW_INPUT_STREAM = "RegisterNewInputStream": String!

EVENT_RELEASE

const val EVENT_RELEASE = "Release": String!

EVENT_RENDERED_TO_OUTPUT_SURFACE

const val EVENT_RENDERED_TO_OUTPUT_SURFACE = "RenderedToOutputSurface": String!

EVENT_SEEK_TO

const val EVENT_SEEK_TO = "SeekTo": String!

EVENT_SET_COMPOSITION

const val EVENT_SET_COMPOSITION = "SetComposition": String!

EVENT_SET_VIDEO_OUTPUT

const val EVENT_SET_VIDEO_OUTPUT = "SetVideoOutput": String!

EVENT_SIGNAL_ENDED

const val EVENT_SIGNAL_ENDED = "SignalEnded": String!

EVENT_SIGNAL_EOS

const val EVENT_SIGNAL_EOS = "SignalEOS": String!

EVENT_START

const val EVENT_START = "Start": String!

EVENT_SURFACE_TEXTURE_INPUT

const val EVENT_SURFACE_TEXTURE_INPUT = "SurfaceTextureInput": String!

EVENT_SURFACE_TEXTURE_TRANSFORM_FIX

const val EVENT_SURFACE_TEXTURE_TRANSFORM_FIX = "SurfaceTextureTransformFix": String!

Public constructors

DebugTraceUtil

DebugTraceUtil()

Public functions

dumpTsv

synchronized java-static fun dumpTsv(writer: Writer!): Unit

Dumps all the logged events to the Writer as tab separated values (tsv).

Throws
`java.io.IOException`

generateTraceSummary

synchronized java-static fun generateTraceSummary(): String!

Generate a summary of the logged events, containing the total number of times an event happened and the detailed log of a window of the oldest and newest events.

logCodecEvent

synchronized java-static fun logCodecEvent(
    isDecoder: Boolean,
    isVideo: Boolean,
    @DebugTraceUtil.Event eventName: @DebugTraceUtil.Event String!,
    presentationTimeUs: Long,
    extraFormat: String!,
    extraArgs: Array<Any!>!
): Unit

Logs an Event for a codec, if debug logging is enabled.

Parameters
`isDecoder: Boolean`	Whether the codec is a decoder.
`isVideo: Boolean`	Whether the codec is for video.
`@DebugTraceUtil.Event eventName: @DebugTraceUtil.Event String!`	The `Event` to log.
`presentationTimeUs: Long`	The current presentation time of the media. Use `TIME_UNSET` if unknown, `TIME_END_OF_SOURCE` if EOS.
`extraFormat: String!`	Format string for optional extra information. See `formatInvariant`.
`extraArgs: Array<Any!>!`	Arguments for optional extra information.

logEvent

synchronized java-static fun logEvent(
    @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!,
    @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!,
    presentationTimeUs: Long
): Unit

Logs a new event, if debug logging is enabled.

Parameters
`@DebugTraceUtil.Component component: @DebugTraceUtil.Component String!`	The `Component` to log.
`@DebugTraceUtil.Event event: @DebugTraceUtil.Event String!`	The `Event` to log.
`presentationTimeUs: Long`	The current presentation time of the media. Use `TIME_UNSET` if unknown, `TIME_END_OF_SOURCE` if EOS.

logEvent

synchronized java-static fun logEvent(
    @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!,
    @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!,
    presentationTimeUs: Long,
    jsonObject: JSONObject!
): Unit

logEvent

synchronized java-static fun logEvent(
    @DebugTraceUtil.Component component: @DebugTraceUtil.Component String!,
    @DebugTraceUtil.Event event: @DebugTraceUtil.Event String!,
    presentationTimeUs: Long,
    extraFormat: String!,
    extraArgs: Array<Any!>!
): Unit

Logs a new event, if debug logging is enabled.

Parameters
`@DebugTraceUtil.Component component: @DebugTraceUtil.Component String!`	The `Component` to log.
`@DebugTraceUtil.Event event: @DebugTraceUtil.Event String!`	The `Event` to log.
`presentationTimeUs: Long`	The current presentation time of the media. Use `TIME_UNSET` if unknown, `TIME_END_OF_SOURCE` if EOS.
`extraFormat: String!`	Format string for optional extra information. See `formatInvariant`.
`extraArgs: Array<Any!>!`	Arguments for optional extra information.

reset

synchronized java-static fun reset(): Unit

Public properties

enableTracing

java-static val enableTracing: Boolean

Whether to store tracing events for debug logging. Should be set to true for testing and debugging purposes only.

DebugTraceUtil

Summary

Nested types

Constants

Public constructors

Public functions

Public properties

Constants

COMPONENT_ASSET_LOADER

COMPONENT_AUDIO_DECODER

COMPONENT_AUDIO_ENCODER

COMPONENT_AUDIO_GRAPH

COMPONENT_AUDIO_MIXER

COMPONENT_BITMAP_TEXTURE_MANAGER

COMPONENT_COMPOSITION_PLAYER

COMPONENT_COMPOSITOR

COMPONENT_EXTERNAL_TEXTURE_MANAGER

COMPONENT_MUXER

COMPONENT_TEX_ID_TEXTURE_MANAGER

COMPONENT_TRANSFORMER_INTERNAL

COMPONENT_VFP

COMPONENT_VIDEO_DECODER

COMPONENT_VIDEO_ENCODER

EVENT_ACCEPTED_INPUT

EVENT_CAN_WRITE_SAMPLE

EVENT_INPUT_ENDED

EVENT_INPUT_FORMAT

EVENT_OUTPUT_ENDED

EVENT_OUTPUT_FORMAT

EVENT_OUTPUT_TEXTURE_RENDERED

EVENT_PRODUCED_OUTPUT

EVENT_QUEUE_BITMAP

EVENT_QUEUE_FRAME

EVENT_QUEUE_TEXTURE

EVENT_RECEIVE_END_OF_ALL_INPUT

EVENT_RECEIVE_EOS

EVENT_REGISTER_NEW_INPUT_STREAM

EVENT_RELEASE

EVENT_RENDERED_TO_OUTPUT_SURFACE

EVENT_SEEK_TO

EVENT_SET_COMPOSITION

EVENT_SET_VIDEO_OUTPUT

EVENT_SIGNAL_ENDED

EVENT_SIGNAL_EOS

EVENT_START

EVENT_SURFACE_TEXTURE_INPUT

EVENT_SURFACE_TEXTURE_TRANSFORM_FIX

Public constructors

DebugTraceUtil

Public functions

dumpTsv

generateTraceSummary

logCodecEvent

logEvent

logEvent

logEvent

reset

Public properties

enableTracing