MixedStreamConfig class

Inheritance
  • Object
  • PackClass
  • MixedStreamConfig

Constructors

MixedStreamConfig({required MixedStreamVideoConfig videoConfig, required MixedStreamAudioConfig audioConfig, required MixedStreamControlConfig controlConfig, required MixedStreamSpatialAudioConfig spatialAudioConfig, required List<MixedStreamLayoutRegionConfig> regions, required String userConfigExtraInfo, required String backgroundColor, required String backgroundImageUrl, required dynamic advancedConfig, required String roomId, required String userId, required dynamic authInfo, required InterpolationMode interpolationMode, required StreamLayoutMode layoutMode, String? pushURL, MixedStreamPushTargetType? pushTargetType, bool? $disableInit})
MixedStreamConfig.fromMap(Map<String, dynamic> map)
factory

Properties

$instance → dynamic
no setterinherited
advancedConfig ↔ dynamic
@hidden for internal use only
getter/setter pair
audioConfig ↔ MixedStreamAudioConfig
@detail api @brief Sets audio transcoding configurations. It's recommended to be set. @param audioConfig The audio configurations to be set. See MixedStreamAudioConfig{@link #MixedStreamConfig-MixedStreamAudioConfig}.
getter/setter pair
authInfo ↔ dynamic
@hidden for internal use only
getter/setter pair
backgroundColor ↔ String
@detail api @brief Sets the background color of the canvas. With invalid or empty input, the configurations will be set as the default values. @param backgroundColor Background-color of the mixed stream in hexadecimal values such as #FFFFFF and #000000. The default value is #000000 (black).
getter/setter pair
backgroundImageUrl ↔ String
@valid since 3.57 @detail api @brief Sets the URL of the background image for the canvas that renders the mixed stream @param backgroundImageURL URL of the background image with a maximum length of 1023 bytes.
The URL must start with http, and you can input images in the following supported formats: JPG, JPEG, PNG.
If the width and height of the background image are different from the screen dimensions, the background image will be scaled to fill the screen.
getter/setter pair
controlConfig ↔ MixedStreamControlConfig
@valid since 3.56 @detail api @brief Sets the configurations during mixing streams on the server side. @param controlConfig The configurations to be set. See MixedStreamControlConfig{@link #MixedStreamConfig-MixedStreamControlConfig}.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
interpolationMode ↔ InterpolationMode
@detail api @brief Sets the interpolationMode mode of the WTN stream. See InterpolationMode{@link #InterpolationMode}.
getter/setter pair
layoutMode ↔ StreamLayoutMode
@detail api @brief Sets the layout mode of the WTN stream. See StreamLayoutMode{@link #StreamLayoutMode}.
getter/setter pair
pushTargetType ↔ MixedStreamPushTargetType?
@platform ios @brief Layout mode. See ByteRTCMixedStreamPushTargetType{@link #ByteRTCMixedStreamPushTargetType}. The optional values:
getter/setter pair
pushURL ↔ String?
@platform ios @hidden for internal use only @brief The URL for live transcoding. Only supports live transcoding via RTMP. The URL should match the regular expression /^rtmps?:\\/\\//. It's recommended to be set.
- This parameters cannot be updated during the task. - This parameter is not supported for WTN stream tasks.
getter/setter pair
regions ↔ List<MixedStreamLayoutRegionConfig>
@detail api @brief Sets the user layout information list. @param regions User layout information list. It's a list of MixedStreamLayoutRegionConfig{@link #MixedStreamConfig#MixedStreamLayoutRegionConfig} that you construct for each stream.
With invalid or empty input, the configurations will be set as the default values.
getter/setter pair
roomId ↔ String
@detail api @brief Set the room ID to specify where the streams to be mixed sources from. @param roomID The room ID @note This parameters cannot be updated during.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spatialAudioConfig ↔ MixedStreamSpatialAudioConfig
@detail api @brief Sets the spatial audio configuration when pushing streams to CDN. @param spatialConfig The configurations to be set. See MixedStreamSpatialAudioConfig{@link #MixedStreamConfig-MixedStreamSpatialAudioConfig}.
getter/setter pair
userConfigExtraInfo ↔ String
@detail api @brief set user config extra information. @param userConfigExtraInfo Extra information. @note This parameter is not supported for WTN stream tasks.
getter/setter pair
userId ↔ String
@detail api @brief Sets the user ID to specify who started the mixing-stream task. The sum length of roomID and userID should not exceed 126 bytes. It's recommended to be set.
This parameter cannot be updated during the. @param userID The user ID.
getter/setter pair
videoConfig ↔ MixedStreamVideoConfig
@detail api @brief Sets the video transcoding configurations. It's recommended to be set. @param videoConfig The configurations to be set. See MixedStreamVideoConfig{@link #MixedStreamConfig-MixedStreamVideoConfig}.
getter/setter pair

Methods

$createInstance(List args) → dynamic
Factory method for creating instances
override
$destroy() → void
inherited
$init(List args) → void
inherited
android_getMixedStreamAdvancedConfig() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamAudioConfigAudioProfile() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamaudioConfigBitrate() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamAudioConfigChannels() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamAudioConfigCodec() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamAudioConfigSampleRate() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamAuthInfo() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamBackgroundColor() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamBackgroundImageURL() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamInterpolationMode() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutMode() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutmode() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionAlpha(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionAlternateImageFillMode(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionAlternateImageURL(MixedStreamLayoutRegionConfig region) → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionApplySpatialAudio(MixedStreamLayoutRegionConfig region) → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionConfigs() → Future<Array<MixedStreamLayoutRegionConfig>?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionContentType(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionCornerRadius(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionData(MixedStreamLayoutRegionConfig region) → Future<ArrayBuffer?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionDataParamImageHeight(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionDataParamImageWidth(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionH(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionLocalUser(MixedStreamLayoutRegionConfig region) → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionMediaType(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionRenderMode(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionRoomID(MixedStreamLayoutRegionConfig region) → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionScreenStream(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionSpatialPositionX(MixedStreamLayoutRegionConfig region) → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionSpatialPositionY(MixedStreamLayoutRegionConfig region) → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionSpatialPositionZ(MixedStreamLayoutRegionConfig region) → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionUserID(MixedStreamLayoutRegionConfig region) → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionW(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionX(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionY(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutRegionZOrder(MixedStreamLayoutRegionConfig region) → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutSourceCropH(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutSourceCropW(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutSourceCropX(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamLayoutSourceCropY(MixedStreamLayoutRegionConfig region) → Future<double?>
@platform android @hidden constructor/destructor
android_getMixedStreamRoomID() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigEnableVolumeIndication() → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigIsAddVolumeValue() → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigMediaType() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigPushStreamMode() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigSeiContentMode() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigSeiPayloadType() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigSeiPayloadUuid() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigTalkVolume() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamServerControlConfigVolumeIndicationInterval() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationForwardX() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationForwardY() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationForwardZ() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationRightX() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationRightY() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationRightZ() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationUpX() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationUpY() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialOrientationUpZ() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialPositionX() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialPositionY() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigAudienceSpatialPositionZ() → Future<float?>
@platform android @hidden constructor/destructor
android_getMixedStreamSpatialConfigEnableSpatialRender() → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamSyncControlConfigBaseUser() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamSyncControlConfigQueueLength() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamSyncControlConfigSyncStrategy() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamSyncControlConfigVideoNeedMix() → Future<bool?>
@platform android @hidden constructor/destructor
android_getMixedStreamUserConfigExtraInfo() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamUserID() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigBFrame() → Future<bool?>
@platform android
android_getMixedStreamVideoConfigBitrate() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigCodec() → Future<string?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigFps() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigGop() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigHeight() → Future<int?>
@platform android @hidden constructor/destructor
android_getMixedStreamVideoConfigWidth() → Future<int?>
@platform android @hidden constructor/destructor
android_getTranscodeMessage() → Future
@platform android @hidden constructor/destructor
findOverrideIndices(List args, List<List<int>> indicesList) → List<int>
查找重载参数下标列表 @desc android 构造函数存在重载 此方法通过实际传入参数与构造函数参数列表集合的比对，来获取当前实际的需要使用的参数列表
inherited
fn2AndroidClass(Function callback, dynamic nativeClass(), String methodName) → dynamic
与 ts runtime 中的 fn2AndroidClass 功能一致 将 Dart 函数转换为 Android 回调类实例供 Android 侧使用
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited
transformToPlatformConstructorArgs(List args, List<int> indices, Map<String, dynamic> typeMap, Map<String, dynamic> enumMap, Map<String, dynamic> classMap, String platformVar) → List
实例化参数处理 将 pack 过后的 enum / class 转成 android / ios 平台侧的 enum / class
inherited
updateInstance(dynamic instance) → void
inherited

Operators

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

Static Methods

deepPackedMapValues(Map<String, dynamic> map) → dynamic
defaultMixedStreamConfig() → Future<MixedStreamConfig?>
mapMemberToConstructorParams(Map json) → Map<String, dynamic>