ByteRTCSubscribeConfig class

Inheritance
  • Object
  • NativeClass
  • ByteRTCSubscribeConfig

Constructors

ByteRTCSubscribeConfig([NativeClassOptions? options])

Properties

$resource → NativeResource
no setterinherited
framerate FutureOr<NSInteger?>
@brief Expected maximum frame rate of the subscribed stream in px. The default value is 0, values greater than 10 are valid.
If the frame rate of the stream published is higher than the value set by the subscriber, the subscriber receives the video of the frame rate set by this API; if the frame rate of the stream published is lower than the value set by the subscriber, the subscriber receives the video of the same frame rate of the video published.
Only valid if the stream is coded with SVC technique.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
height FutureOr<NSInteger?>
@brief The height in px of the subscription, the default value is 0.
getter/setter pair
isScreen FutureOr<BOOL?>
@brief Whether it is a screen stream.
By setting this parameter, the user subscribes to the screen share stream or non-screen share stream published by the remote user. YES is a subscription screen share flow, NO is a subscription non-screen share flow, the default value is YES.
getter/setter pair
ready Future<void>
Whether the instance is initialized
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subscribeAudio FutureOr<BOOL?>
@brief Whether to subscribe to audio.
The user selects whether to subscribe to audio in the remote stream by setting this parameter. YES is subscribed audio, NO is not subscribed audio, the default value is YES.
getter/setter pair
subscribeVideo FutureOr<BOOL?>
@brief Whether to subscribe to videos.
The user selects whether to subscribe to videos in the remote stream by setting this parameter. YES is a subscription video, NO is a non-subscription video, the default value is YES.
getter/setter pair
subVideoIndex FutureOr<NSInteger?>
@hidden for internal use only
getter/setter pair
svcLayer FutureOr<NSInteger?>
@brief Time domain hierarchy of the subscribed video stream, default value is 0.
getter/setter pair
videoIndex FutureOr<NSInteger?>
@brief Subscribed video stream resolution subscript.
Users can publish multiple videos streams of different resolutions by calling the setVideoEncoderConfig:{@link #ByteRTCEngine#setVideoEncoderConfig} method. Therefore, when subscribing to a stream, you need to specify the specific resolution of the subscription. This parameter is used to specify the subscript of the resolution to be subscribed to, and the default value is 0.
getter/setter pair
width FutureOr<NSInteger?>
@brief The width in px of the subscription, the default value is 0.
getter/setter pair

Methods

destroy() → void
inherited
nativeCall<T>(String method, [List? args, NativeMethodMeta? meta]) Future<T>
Call instance method
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendInstanceGet<T>(String property) Future<T>
Get instance property
inherited
sendInstancePropertiesGet(dynamic nativeClass) Future<Map<String, dynamic>>
Get instance properties
inherited
sendInstanceSet(String property, dynamic value) Future<void>
Set instance property
inherited
toString() String
A string representation of this object.
inherited
updateResource(NativeResource resource) → void
inherited

Operators

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

Static Properties

codegen_$namespace → dynamic
no setter