SessionConfigurationLegacy.Builder


class SessionConfigurationLegacy.Builder


Simple builder class for SessionConfigurationLegacy.

Summary

Public constructors

Public functions

SessionConfigurationLegacy.Builder

Add an OutputConfiguration to the session configuration.

SessionConfigurationLegacy.Builder

Add a collection of OutputConfigurations to the session configuration.

SessionConfigurationLegacy

Builds a SessionConfigurationLegacy.

SessionConfigurationLegacy.Builder

Sets the session parameters for the session configuration.

Public constructors

Builder

Added in 1.5.0-beta01
Builder()

Public functions

addOutputConfiguration

Added in 1.5.0-beta01
fun addOutputConfiguration(outputConfig: OutputConfiguration): SessionConfigurationLegacy.Builder

Add an OutputConfiguration to the session configuration.

Parameters
outputConfig: OutputConfiguration

OutputConfiguration to add to the session configuration.

Returns
SessionConfigurationLegacy.Builder

the current builder

addOutputConfigurations

Added in 1.5.0-beta01
fun addOutputConfigurations(
    outputConfigs: (Mutable)Collection<OutputConfiguration>
): SessionConfigurationLegacy.Builder

Add a collection of OutputConfigurations to the session configuration.

Parameters
outputConfigs: (Mutable)Collection<OutputConfiguration>

Collection of OutputConfigurations to add.

Returns
SessionConfigurationLegacy.Builder

the current builder

build

Added in 1.5.0-beta01
fun build(): SessionConfigurationLegacy

Builds a SessionConfigurationLegacy.

Note that the created SessionConfigurationLegacy 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 SessionConfigurationLegacy.

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

setSessionParameters

Added in 1.5.0-beta01
fun setSessionParameters(sessionParams: SessionParametersLegacy): SessionConfigurationLegacy.Builder

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

Parameters
sessionParams: SessionParametersLegacy

session parameters to be associated with the session configuration

Returns
SessionConfigurationLegacy.Builder

the current builder