VoxaRtc class

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

adaptiveStream ↔ bool
Let the SDK choose each remote's video layer from how large it is on screen, and pause tracks that are not visible at all.
getter/setter pair
cameraFacePriority ↔ bool
getter/setter pair
cameraNoiseReduction ↔ bool
The two parts of cameraTuning, to turn one off on its own.
getter/setter pair
cameraTuning ↔ bool
Android: ask the camera for what Agora asks it for. Where the camera offers them, its high-quality noise reduction and exposure metered on the face are requested. A camera where that costs frame rate is found out in its first seconds and put back on the fast setting.
getter/setter pair
hdLadder ↔ bool
More bits for the picture. A 1280x720 camera goes out at 2000 kbps in place of 1500 (at 24 fps), and its two smaller layers are 540p at 800 kbps and 270p at 250 in place of 360p at 350 and 180p at 150: a viewer the server has to step down sees 540p, not 360p. It applies to a camera from 1280x720 up to, not including, 1920x1080; smaller and larger ones are not changed. A bitrate the app sets itself still decides the top.
getter/setter pair
serverUrl ↔ String?
Compat Gateway URL. The Agora-format token passed to joinChannel is sent here; the gateway verifies it and joins the media room on the app's behalf.
getter/setter pair
transportFactory ↔ VoxaTransport Function()?
Test/DI hook: overrides the transport the engine creates per join. null = the real media transport.
getter/setter pair
videoCodec ↔ String?
The codec the camera is published in: 'vp8', 'h264', or null to let the SDK choose, which is the default.
getter/setter pair
videoStatsLog ↔ void Function(String line)?
Where the SDK writes one line about the outgoing camera video: the codec, whether the encoder is the phone's hardware, and each layer's size, frame rate, bitrate and how hard it is being compressed. One line every ten seconds during a call and one whenever any of that changes; nothing that identifies the user or the room is in it.
getter/setter pair

Static Methods

applyCameraTuning() → Future<void>
Sends the camera settings above to the camera now. Safe at any time, with or without a camera open, and it never throws.
warmUp() → Future<void>
Opens the connection to serverUrl before a join is asked for, so joinChannel starts the token exchange at once instead of first paying for DNS, TCP and TLS — a few hundred milliseconds on a phone.