CallClientState class

A representation of a CallClient's state for consumption in Widgets through a BuildContext.

Note that the CallClient's internal state may have been updated after this CallClientState was instantiated. As such, the static accessors in this class may sometimes yield different values from the corresponding CallClient ones.

Inheritance

• Object
• DiagnosticableTree
• Widget
• ProxyWidget
• InheritedWidget
• InheritedModel<CallClientStateAspect>
• CallClientState

Properties

activeSpeaker → Participant?

See CallClient.activeSpeaker.

final

availableDevices → Devices

See CallClient.availableDevices.

final

callClient → CallClient

The CallClient that was the source of this state.

final

callConfig → CallConfig?

See CallClient.callConfig.

final

callState → CallState

See CallClient.callState.

final

child → Widget

The widget below this widget in the tree.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

inputs → InputSettings

See CallClient.inputs.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

participantCounts → ParticipantCounts

See CallClient.participantCounts.

final

participants → Participants

See CallClient.participants.

final

publishing → PublishingSettings

See CallClient.publishing.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subscriptionProfiles → Map<SubscriptionProfile, MediaSubscriptionSettings>

See CallClient.subscriptionProfiles.

final

subscriptions → Map<ParticipantId, SubscriptionSettings>

See CallClient.subscriptions.

final

username → String?

See CallClient.username.

no setter

Methods

createElement() → InheritedModelElement<CallClientStateAspect>

Inflates this configuration to a concrete instance.

inherited

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

override

isSupportedAspect(Object aspect) → bool

Returns true if this model supports the given aspect.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

updateShouldNotify(covariant CallClientState oldWidget) → bool

Whether the framework should notify widgets that inherit from this widget.

override

updateShouldNotifyDependent(covariant CallClientState oldWidget, Set<CallClientStateAspect> dependencies) → bool

Return true if the changes between this model and oldWidget match any of the dependencies.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

activeSpeakerOf(BuildContext context) → Participant?

See CallClient.activeSpeaker.

availableDevicesOf(BuildContext context) → Devices

See CallClient.availableDevices.

callConfigOf(BuildContext context) → CallConfig?

See CallClient.callConfig.

callStateOf(BuildContext context) → CallState

See CallClient.callState.

inputsOf(BuildContext context) → InputSettings

See CallClient.inputs.

maybeActiveSpeakerOf(BuildContext context) → Participant?

See CallClient.activeSpeaker.

maybeAvailableDevicesOf(BuildContext context) → Devices?

See CallClient.availableDevices.

maybeCallConfigOf(BuildContext context) → CallConfig?

See CallClient.callConfig.

maybeCallStateOf(BuildContext context) → CallState?

See CallClient.callState.

maybeInputsOf(BuildContext context) → InputSettings?

See CallClient.inputs.

maybeOf(BuildContext context, [CallClientStateAspect? aspect]) → CallClientState?

maybeParticipantCountsOf(BuildContext context) → ParticipantCounts?

See CallClient.participantCounts.

maybeParticipantsOf(BuildContext context) → Participants?

See CallClient.participants.

maybePublishingOf(BuildContext context) → PublishingSettings?

See CallClient.publishing.

maybeSubscriptionProfilesOf(BuildContext context) → Map<SubscriptionProfile, MediaSubscriptionSettings>?

See CallClient.subscriptionProfiles.

maybeSubscriptionsOf(BuildContext context) → Map<ParticipantId, SubscriptionSettings>?

See CallClient.subscriptions.

maybeUsernameOf(BuildContext context) → String?

See CallClient.username.

of(BuildContext context, [CallClientStateAspect? aspect]) → CallClientState

participantCountsOf(BuildContext context) → ParticipantCounts

See CallClient.participantCounts.

participantsOf(BuildContext context) → Participants

See CallClient.participants.

publishingOf(BuildContext context) → PublishingSettings

See CallClient.publishing.

subscriptionProfilesOf(BuildContext context) → Map<SubscriptionProfile, MediaSubscriptionSettings>

See CallClient.subscriptionProfiles.

subscriptionsOf(BuildContext context) → Map<ParticipantId, SubscriptionSettings>

See CallClient.subscriptions.

usernameOf(BuildContext context) → String?

See CallClient.username.