CallParams class

Call parameter configuration, used to set room ID, timeout, custom data, and other parameters when initiating an audio/video call.

Configuration parameters for initiating audio/video calls, including room ID, timeout, custom data, etc.

Constructors

CallParams({String roomId = "", int timeout = 30, String userData = "", String chatGroupId = "", bool isEphemeralCall = false, CloudRecordPolicy cloudRecordPolicy = CloudRecordPolicy.followConsoleConfig, String offlinePushTitle = "", String offlinePushDescription = ""})

Properties

chatGroupId ↔ String

Tencent Cloud IM group ID. Optional parameter. Only needs to be provided in the "call initiated from a group chat" scenario. When provided, the system will route signaling and associate this call with the group's call records, for sending call start/end status messages in the group chat and for inviting group members to join the call during the call. For one-on-one calls, or ad-hoc multi-party calls not bound to a specific group, always leave this empty. Note: This field takes effect on the initial calls invocation; subsequent invite parameters cannot change the group bound to this call.

getter/setter pair

cloudRecordPolicy ↔ CloudRecordPolicy

Cloud recording policy for this call. Prerequisite: the relevant capability must already be enabled in the console.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isEphemeralCall ↔ bool

Ephemeral call. Optional parameter. When set to true, no call message will be generated after this call ends. Common scenario: initiating a call in a 1v1 chat without displaying the call message.

getter/setter pair

offlinePushDescription ↔ String

Offline push notification description. When not empty, overrides the default description.

getter/setter pair

offlinePushTitle ↔ String

Offline push notification title. When not empty, overrides the default title (login user's nickname).

getter/setter pair

roomId ↔ String

TRTC room ID (CallStore's media stream management uses Tencent Cloud TRTC service). Optional parameter. When not provided, it is automatically generated by the server; if your app needs to specify or reuse a TRTC room, you can pass in a specific string.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timeout ↔ int

Ring timeout duration (seconds). Optional parameter. Only controls the unanswered timeout phase from call initiation (calls) to answer. Does not apply to already connected calls or invite operations. When set to 0, the server default (30s) will be used.

getter/setter pair

userData ↔ String

Custom pass-through data attached when making a call. Optional parameter. This data is primarily exposed to the callee's business logic via the onCallReceived event. Note: It does not enter the long-term CallInfo state, nor is it persisted to call records. It is recommended to pass a short JSON string.

getter/setter pair

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