CodecParameters.Builder

Kotlin |Java

class CodecParameters.Builder

A builder for CodecParameters instances.

Summary

Public constructors
`Builder()` Creates an empty builder.

Public functions
`CodecParameters!`	`build()` Builds the `CodecParameters` instance.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue remove(key: String!)` Removes a parameter from this builder, preventing it from being applied.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue setByteBuffer(key: String!, value: ByteBuffer?)` Sets a byte buffer parameter value.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue setFloat(key: String!, value: Float)` Sets a float parameter value.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue setInteger(key: String!, value: Int)` Sets an integer parameter value.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue setLong(key: String!, value: Long)` Sets a long parameter value.
`CodecParameters.Builder!`	`@CanIgnoreReturnValue setString(key: String!, value: String?)` Sets a string parameter value.

Builder()

Creates an empty builder.

fun build(): CodecParameters!

Builds the CodecParameters instance.

@CanIgnoreReturnValue
fun remove(key: String!): CodecParameters.Builder!

Removes a parameter from this builder, preventing it from being applied.

Note: This does not reset a parameter on a live codec. To do so, explicitly set the parameter to its default value.

Parameters
`key: String!`	The key of the parameter to remove.

Returns
`CodecParameters.Builder!`	This builder.

@CanIgnoreReturnValue
fun setByteBuffer(key: String!, value: ByteBuffer?): CodecParameters.Builder!

Sets a byte buffer parameter value.

Parameters
`key: String!`	The parameter key.
`value: ByteBuffer?`	The `ByteBuffer` value, which may be `null`.

Returns
`CodecParameters.Builder!`	This builder.

@CanIgnoreReturnValue
fun setFloat(key: String!, value: Float): CodecParameters.Builder!

Sets a float parameter value.

Parameters
`key: String!`	The parameter key.
`value: Float`	The float value.

Returns
`CodecParameters.Builder!`	This builder.

@CanIgnoreReturnValue
fun setInteger(key: String!, value: Int): CodecParameters.Builder!

Sets an integer parameter value.

Parameters
`key: String!`	The parameter key.
`value: Int`	The integer value.

Returns
`CodecParameters.Builder!`	This builder.

@CanIgnoreReturnValue
fun setLong(key: String!, value: Long): CodecParameters.Builder!

Sets a long parameter value.

Parameters
`key: String!`	The parameter key.
`value: Long`	The long value.

Returns
`CodecParameters.Builder!`	This builder.

@CanIgnoreReturnValue
fun setString(key: String!, value: String?): CodecParameters.Builder!

Sets a string parameter value.

Parameters
`key: String!`	The parameter key.
`value: String?`	The string value, which may be `null`.

Returns
`CodecParameters.Builder!`	This builder.