agorauikit_android/io.agora.agorauikit_android/AgoraSettings

AgoraSettings

class AgoraSettings

Settings used for the display and behaviour of AgoraVideoViewer

Constructors

fun AgoraSettings()

Types

enum BuiltinButton : Enum<AgoraSettings.BuiltinButton>

Enum value for all the default buttons offered by the VideoUIKit

object Companion

enum Position : Enum<AgoraSettings.Position>

Position, top, left, bottom or right.

Properties

var buttonPosition: AgoraSettings.Position

Where the buttons such as camera enable/disable should be positioned within the view. TODO: This is not yet implemented

var colors: AgoraViewerColors

Colors for views inside AgoraVideoViewer

var enabledButtons: MutableSet<AgoraSettings.BuiltinButton>

Which buttons should be enabled in this AgoraVideoView.

var extraButtons: MutableList<AgoraButton>

A mutable list to add buttons to the default list of BuiltinButton

var floatPosition: AgoraSettings.Position

Where the floating collection view of video members be positioned within the view. TODO: This is not yet implemented

gridThresholdHighBitrate

var gridThresholdHighBitrate: Int = 5

Maximum number of videos in the grid view before the low bitrate is adopted.

lowBitRateStream

var lowBitRateStream: String? = null

Full string for low bitrate stream parameter, including key of che.video.lowBitRateStreamParameter.

var rtmEnabled: Boolean = true

Whether RTM should be initialised and used

var tokenURL: String? = null

URL to fetch tokens from. If supplied, this package will automatically fetch tokens when the Agora Engine indicates it will be needed. It will follow the URL pattern found in AgoraIO-Community/agora-token-service

usingDualStream

var usingDualStream: Boolean

Whether we are using dual stream mode, which helps to reduce Agora costs.

videoConfiguration

var videoConfiguration: VideoEncoderConfiguration

Agora's video encoder configuration.

videoRenderMode

var videoRenderMode: Int

The rendering mode of the video view for all videos within the view.