CodecParameters

@UnstableApi
class CodecParameters

An immutable collection of parameters to be applied to a codec.

Summary

Nested types

A builder for CodecParameters instances.

Constants
const CodecParameters!

An empty CodecParameters instance.

Public functions
CodecParameters.Builder!

Returns a new Builder initialized with the values of this instance.
Boolean
equals(obj: Any?)
Any?
get(key: String!)

Retrieves a parameter value by its key.
Int
(Mutable)Set<String!>!

Returns a Set of the keys contained in this instance.

Constants

EMPTY

const val EMPTY: CodecParameters!

An empty CodecParameters instance.

Public functions

buildUpon

fun buildUpon(): CodecParameters.Builder!

Returns a new Builder initialized with the values of this instance.

equals

fun equals(obj: Any?): Boolean

get

fun get(key: String!): Any?

Retrieves a parameter value by its key.

Note: If the returned value is a ByteBuffer, it must be treated as read-only. Modifying the returned ByteBuffer will affect this CodecParameters instance and may lead to unexpected behavior.

Parameters
key: String!

A string representing the key of the codec parameter.
Returns
Any?

The value of the requested parameter, or null if the key is not present.

hashCode

fun hashCode(): Int

keySet

fun keySet(): (Mutable)Set<String!>!

Returns a Set of the keys contained in this instance.