agorauikit_android/io.agora.agorauikit_android/AgoraVideoViewer

AgoraVideoViewer

open class AgoraVideoViewer : FrameLayout

View to contain all the video session objects, including camera feeds and buttons for settings

Constructors

fun AgoraVideoViewer(context: Context, connectionData: AgoraConnectionData, style: AgoraVideoViewer.Style = Style.FLOATING, agoraSettings: AgoraSettings = AgoraSettings(), delegate: AgoraVideoViewerDelegate? = null)

Creates an AgoraVideoViewer object, to be placed anywhere in your application.

Types

Companion

object Companion

Style

enum Style : Enum<AgoraVideoViewer.Style>

Style and organisation to be applied to all the videos in this view.

Functions

isAgRtmChannelInitialized

fun isAgRtmChannelInitialized(): Boolean

isAgRtmClientInitialized

fun isAgRtmClientInitialized(): Boolean

join

@JvmOverloads

fun join(channel: String, fetchToken: Boolean, role: Int? = null, uid: Int? = null)

@JvmOverloads

fun join(channel: String, token: String? = null, role: Int? = null, uid: Int? = null)

Join the Agora channel with optional token request

leaveChannel

fun leaveChannel(): Int

Leave channel stops all preview elements

triggerLoginToRtm

fun triggerLoginToRtm()

Properties

activeSpeaker

var activeSpeaker: Int? = null

The most recently active speaker in the session. This will only ever be set to remote users, not the local user.

agkit

lateinit var agkit: RtcEngine

RtcEngine being used by this AgoraVideoViewer

agoraRtmController

val agoraRtmController: AgoraRtmController

agoraSettings

var agoraSettings: AgoraSettings

Settings and customisations such as position of on-screen buttons, collection view of all channel members, as well as agora video configuration.

agRtmChannel

lateinit var agRtmChannel: RtmChannel

agRtmClient

lateinit var agRtmClient: RtmClient

RTM client used by this AgoraVideoViewer

beautyOptions

open val beautyOptions: BeautyOptions

Default beautification settings

collectionViewVideos

val collectionViewVideos: Map<Int, AgoraSingleVideoView>

Video views to be displayed in the floating collection view.

delegate

var delegate: AgoraVideoViewerDelegate? = null

Delegate for the AgoraVideoViewer, used for some important callback methods.

isInRtcChannel

var isInRtcChannel: Boolean? = false

A boolean to check whether the user has joined the RTC channel or not.

overrideActiveSpeaker

var overrideActiveSpeaker: Int? = null

Active speaker override.

rtcOverrideHandler

var rtcOverrideHandler: IRtcEngineEventHandler? = null

rtmChannelOverrideHandler

var rtmChannelOverrideHandler: AgoraRtmChannelHandler? = null

rtmClientOverrideHandler

var rtmClientOverrideHandler: AgoraRtmClientHandler? = null

style

var style: AgoraVideoViewer.Style

Style and organisation to be applied to all the videos in this AgoraVideoViewer.

TAG

val TAG: String

userID

var userID: Int = 0

ID of the local user. Setting to zero will tell Agora to assign one for you once connected.

userRole

var userRole: Int

Gets and sets the role for the user. Either .audience or .broadcaster.

Extensions

organiseRecycleFloating

@ExperimentalUnsignedTypes

fun AgoraVideoViewer.organiseRecycleFloating()

Update the contents of the floating view

organiseRecycleGrid

@ExperimentalUnsignedTypes

fun AgoraVideoViewer.organiseRecycleGrid()

Update the contents of the main grid view

reorganiseVideos

@ExperimentalUnsignedTypes

fun AgoraVideoViewer.reorganiseVideos()

Shuffle around the videos depending on the style