AgoraSettings

public final class AgoraSettings

Settings used for the display and behaviour of AgoraVideoViewer

Constructors

AgoraSettings
Link copied to clipboard
AgoraSettings AgoraSettings()

Types

BuiltinButton
Link copied to clipboard
public enum BuiltinButton extends Enum<AgoraSettings.BuiltinButton>
Companion
Link copied to clipboard
public class Companion
Position
Link copied to clipboard
public enum Position extends Enum<AgoraSettings.Position>
Position, top, left, bottom or right.

Functions

getButtonPosition
Link copied to clipboard
final AgoraSettings.Position getButtonPosition()
Where the buttons such as camera enable/disable should be positioned within the view.
getColors
Link copied to clipboard
final AgoraViewerColors getColors()
Colors for views inside AgoraVideoViewer
getEnabledButtons
Link copied to clipboard
final Set<AgoraSettings.BuiltinButtongetEnabledButtons()
Which buttons should be enabled in this AgoraVideoView.
getExtraButtons
Link copied to clipboard
final List<AgoraButtongetExtraButtons()
getFloatPosition
Link copied to clipboard
final AgoraSettings.Position getFloatPosition()
Where the floating collection view of video members be positioned within the view.
getGridThresholdHighBitrate
Link copied to clipboard
final Integer getGridThresholdHighBitrate()
Maximum number of videos in the grid view before the low bitrate is adopted.
getLowBitRateStream
Link copied to clipboard
final String getLowBitRateStream()
Full string for low bitrate stream parameter, including key of che.video.lowBitRateStreamParameter.
getTokenURL
Link copied to clipboard
final String getTokenURL()
URL to fetch tokens from.
getUsingDualStream
Link copied to clipboard
final Boolean getUsingDualStream()
getVideoConfiguration
Link copied to clipboard
final VideoEncoderConfiguration getVideoConfiguration()
Agora's video encoder configuration.
getVideoRenderMode
Link copied to clipboard
final Integer getVideoRenderMode()
The rendering mode of the video view for all videos within the view.
setButtonPosition
Link copied to clipboard
final Unit setButtonPosition(AgoraSettings.Position buttonPosition)
Where the buttons such as camera enable/disable should be positioned within the view.
setColors
Link copied to clipboard
final Unit setColors(AgoraViewerColors colors)
Colors for views inside AgoraVideoViewer
setEnabledButtons
Link copied to clipboard
final Unit setEnabledButtons(Set<AgoraSettings.BuiltinButton> enabledButtons)
Which buttons should be enabled in this AgoraVideoView.
setExtraButtons
Link copied to clipboard
final Unit setExtraButtons(List<AgoraButton> extraButtons)
setFloatPosition
Link copied to clipboard
final Unit setFloatPosition(AgoraSettings.Position floatPosition)
Where the floating collection view of video members be positioned within the view.
setGridThresholdHighBitrate
Link copied to clipboard
final Unit setGridThresholdHighBitrate(Integer gridThresholdHighBitrate)
Maximum number of videos in the grid view before the low bitrate is adopted.
setLowBitRateStream
Link copied to clipboard
final Unit setLowBitRateStream(String lowBitRateStream)
Full string for low bitrate stream parameter, including key of che.video.lowBitRateStreamParameter.
setTokenURL
Link copied to clipboard
final Unit setTokenURL(String tokenURL)
URL to fetch tokens from.
setUsingDualStream
Link copied to clipboard
final Unit setUsingDualStream(Boolean usingDualStream)
setVideoConfiguration
Link copied to clipboard
final Unit setVideoConfiguration(VideoEncoderConfiguration videoConfiguration)
Agora's video encoder configuration.
setVideoRenderMode
Link copied to clipboard
final Unit setVideoRenderMode(Integer videoRenderMode)
The rendering mode of the video view for all videos within the view.

Properties

buttonPosition
Link copied to clipboard
private AgoraSettings.Position buttonPosition
Where the buttons such as camera enable/disable should be positioned within the view.
colors
Link copied to clipboard
private AgoraViewerColors colors
Colors for views inside AgoraVideoViewer
enabledButtons
Link copied to clipboard
private Set<AgoraSettings.BuiltinButtonenabledButtons
Which buttons should be enabled in this AgoraVideoView.
extraButtons
Link copied to clipboard
private List<AgoraButtonextraButtons
floatPosition
Link copied to clipboard
private AgoraSettings.Position floatPosition
Where the floating collection view of video members be positioned within the view.
gridThresholdHighBitrate
Link copied to clipboard
private Integer gridThresholdHighBitrate
Maximum number of videos in the grid view before the low bitrate is adopted.
lowBitRateStream
Link copied to clipboard
private String lowBitRateStream
Full string for low bitrate stream parameter, including key of che.video.lowBitRateStreamParameter.
tokenURL
Link copied to clipboard
private String tokenURL
URL to fetch tokens from.
usingDualStream
Link copied to clipboard
private Boolean usingDualStream
Whether we are using dual stream mode, which helps to reduce Agora costs.
videoConfiguration
Link copied to clipboard
private VideoEncoderConfiguration videoConfiguration
Agora's video encoder configuration.
videoRenderMode
Link copied to clipboard
private Integer videoRenderMode
The rendering mode of the video view for all videos within the view.