nutrient/com.pspdfkit.annotations.sound/EmbeddedAudioSource

EmbeddedAudioSource

open class EmbeddedAudioSource

Represents a source of audio data that can be embedded inside a SoundAnnotation.

Constructors

EmbeddedAudioSource

constructor(@NonNull audioDataProvider: DataProvider, @NonNull audioEncoding: AudioEncoding, @IntRange(from = 1) sampleRate: Int, @IntRange(from = 8) sampleSize: Int, @IntRange(from = 1) channels: Int, @Nullable description: String)

Constructs an embedded audio source with data served from a DataProvider.

constructor(@NonNull audioData: Array<Byte>, @NonNull audioEncoding: AudioEncoding, @IntRange(from = 1) sampleRate: Int, @IntRange(from = 8) sampleSize: Int, @IntRange(from = 1) channels: Int, @Nullable description: String)

Constructs an embedded audio source with data served from memory.

Properties

val audioEncoding: AudioEncoding

The encoding format of the audio samples.

val channels: Int

The number of audio channels.

val dataProvider: DataProvider

Provider for the raw audio data.

DURATION_UNKNOWN

val DURATION_UNKNOWN: Int = -1

Constant value returned from getDuration to signal an error during retrieval of the actual audio clip duration.

val sampleRate: Int

The sampling rate in samples per second (Hz).

val sampleSize: Int

The number of bits per sample value per channel.

Functions

open fun getDescription(): String

Returns audio data description.

open fun getDuration(): Long

Audio duration in millisecond.