SessionConfigurationCompat.Builder

class SessionConfigurationCompat.Builder

Simple builder class for SessionConfigurationCompat. Use builder to obtain a builder object.

Summary

Public functions
SessionConfigurationCompat.Builder

Add an OutputConfiguration to the session configuration.
SessionConfigurationCompat

Builds a SessionConfigurationCompat.
SessionConfigurationCompat.Builder

Sets the session parameters for the session configuration.

Public functions

addOutputConfiguration

Added in 1.5.0-alpha06
fun addOutputConfiguration(outputConfig: OutputConfiguration): SessionConfigurationCompat.Builder

Add an OutputConfiguration to the session configuration.

Parameters
outputConfig: OutputConfiguration

OutputConfiguration to add to the session configuration.
Returns
SessionConfigurationCompat.Builder

the current builder

build

Added in 1.5.0-alpha06
fun build(): SessionConfigurationCompat

Builds a SessionConfigurationCompat.

Note that the created SessionConfigurationCompat makes a shallow copy of the OutputConfigurations added via addOutputConfiguration, and so any mutations to the added OutputConfiguration objects will be reflected in the created SessionConfigurationCompat.

This is quirk of implementation, and it is generally recommended to treat OutputConfiguration objects as immutable once they have been added to a SessionConfigurationCompat.Builder.

Returns
SessionConfigurationCompat

a new SessionConfigurationCompat object.

setSessionParameters

Added in 1.5.0-alpha06
fun setSessionParameters(sessionParams: SessionParametersCompat): SessionConfigurationCompat.Builder

Sets the session parameters for the session configuration. Overwrites any previously set session parameters.

Parameters
sessionParams: SessionParametersCompat

session parameters to be associated with the session configuration
Returns
SessionConfigurationCompat.Builder

the current builder