IvsBroadcaster class
A singleton class that manages the IVS (Interactive Video Service) broadcasting. It interfaces with the platform-specific broadcaster implementations to handle broadcasting, camera operations, and streaming settings.
Constructors
- IvsBroadcaster.new()
-
A factory constructor that returns the single instance of IvsBroadcaster.
factory
Properties
-
broadcastHealth
↔ StreamController<
BroadcastHealth> -
A stream controller to handle the broadcast health events.
getter/setter pair
-
broadcastQuality
↔ StreamController<
BroadcastQuality> -
A stream controller to handle the broadcast quality events.
getter/setter pair
-
broadcastState
↔ StreamController<
BroadCastState> -
A stream controller to handle the broadcast state events.
getter/setter pair
- broadcater → IvsBroadcasterPlatform
-
An instance of the platform-specific broadcaster.
final
-
focusPoint
↔ StreamController<
Offset> -
Focus Point Stream Controller
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
onVideoCapturingStream
↔ StreamController<
VideoCapturingModel> -
A stream controller to handle video capturing events.
getter/setter pair
-
retryState
↔ StreamController<
RetryState> -
A stream controller to handle the broadcast retry State.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
captureVideo(
{int seconds = 30}) → Future< void> - Captures a video for the specified number of seconds.
-
changeCamera(
CameraType cameraType) → Future< void> - Switches the camera to the specified CameraType.
-
getAvailableCameraLens(
) → Future< List< IOSCameraLens> > - Gets the available camera lenses.
-
getZoomFactor(
) → Future< ZoomFactor?> - Gets the current zoom factor of the camera.
-
isMuted(
) → Future< bool> - Checks if the broadcaster is muted.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
requestPermissions(
) → Future< bool> - Requests the necessary permissions for broadcasting.
-
setFocusMode(
FocusMode focusMode) → Future< bool?> - Sets the focus mode of the camera.
-
setFocusPoint(
double x, double y) → Future< bool?> - Sets the focus point of the camera.
-
startBroadcast(
) → Future< void> - Starts the broadcast.
-
startPreview(
{required String imgset, required String streamKey, IvsQuality quality = IvsQuality.q720, CameraType cameraType = CameraType.BACK, bool autoReconnect = false}) → Future< void> - Starts the camera preview for the broadcast with the specified settings.
-
stopBroadcast(
) → Future< void> - Stops the ongoing broadcast.
-
stopVideoCapture(
) → Future< void> - Stops the ongoing video capture.
-
toggleMute(
) → Future< void> - Toggles the mute state of the broadcaster.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateCameraLens(
IOSCameraLens cameraLens) → Future< String?> - Updates the camera lens to the specified IOSCameraLens.
-
zoomCamera(
double zoomValue) → Future - Zooms the camera to the specified zoom level.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → IvsBroadcaster
-
The single instance of IvsBroadcaster.
final