CodecParameters.Builder

Kotlin |Java

public final class CodecParameters.Builder

A builder for CodecParameters instances.

Summary

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

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

public Builder()

Creates an empty builder.

public CodecParameters build()

Builds the CodecParameters instance.

@CanIgnoreReturnValue
public CodecParameters.Builder remove(String key)

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
`String key`	The key of the parameter to remove.

Returns
`CodecParameters.Builder`	This builder.

@CanIgnoreReturnValue
public CodecParameters.Builder setByteBuffer(String key, @Nullable ByteBuffer value)

Sets a byte buffer parameter value.

Parameters
`String key`	The parameter key.
`@Nullable ByteBuffer value`	The `ByteBuffer` value, which may be `null`.

Returns
`CodecParameters.Builder`	This builder.

@CanIgnoreReturnValue
public CodecParameters.Builder setFloat(String key, float value)

Sets a float parameter value.

Parameters
`String key`	The parameter key.
`float value`	The float value.

Returns
`CodecParameters.Builder`	This builder.

@CanIgnoreReturnValue
public CodecParameters.Builder setInteger(String key, int value)

Sets an integer parameter value.

Parameters
`String key`	The parameter key.
`int value`	The integer value.

Returns
`CodecParameters.Builder`	This builder.

@CanIgnoreReturnValue
public CodecParameters.Builder setLong(String key, long value)

Sets a long parameter value.

Parameters
`String key`	The parameter key.
`long value`	The long value.

Returns
`CodecParameters.Builder`	This builder.

@CanIgnoreReturnValue
public CodecParameters.Builder setString(String key, @Nullable String value)

Sets a string parameter value.

Parameters
`String key`	The parameter key.
`@Nullable String value`	The string value, which may be `null`.

Returns
`CodecParameters.Builder`	This builder.