VideoForwardingOptions

The VideoForwardingOptions model allows configuring the Video Forwarding functionality that allows:

Setting the maximum number of video streams that may be transmitted to the local participant
Prioritizing specific participants' video streams that need to be transmitted to the local participant
Changing the video forwarding strategy that defines how the SDK should select conference participants whose videos will be received by the local participant

Accessors

videoForwardingStrategy

▸ videoForwardingStrategy: [VideoForwardingStrategy]

The strategy that defines how the SDK should select conference participants whose videos will be transmitted to the local participant.
The selection can be either based on the participants' audio volume or the distance from the local participant.

Returns: [VideoForwardingStrategy]

max

▸ max: Int?

The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 25. The default value is 4. In the case of providing a value smaller than 0, SDK triggers an error. In the case of providing a value greater than 25, the Dolby.io server triggers an error.

Returns: Int?

participants

▸ participants: [VTParticipant]

The list of participants whose video streams should be always transmitted to the local participant.

Returns: [VTParticipant]

Methods

init

▸ init(strategy: VideoForwardingStrategy, max: Int?, participants: VTParticipant, completion: ((_ error: NSError?) -> Void)?))

Creates an instance with all available video forwarding options for the videoForwarding method.

Parameters:

Name	Type	Default	Description
`strategy`	VideoForwardingStrategy	-	The strategy that defines how the SDK should select conference participants whose videos will be transmitted to the local participant. The selection can be either based on the participants' audio volume or the distance from the local participant.
`max`	Int?	nil	The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 25. The default value is 4. In the case of providing a value smaller than 0, SDK triggers the videoForwarding error. In the case of providing a value greater than 25, the Dolby.io server triggers an error.
`participants`	VTParticipant	-	The list of participant objects.
`completion`	((_ error: NSError?) -> Void)?	nil	The block to execute when the query completes.