Interface ILoginSession
A session for an account.
Inherited Members
Namespace: VivoxUnity
Assembly: VivoxUnity.dll
Syntax
public interface ILoginSession : IKeyedItemNotifyPropertyChanged<AccountId>, INotifyPropertyChangedProperties
AccountArchive
The list of account archive messages returned by a BeginAccountArchiveQuery.
Declaration
[Obsolete("This feature is being deprecated in favor of the limited beta release of Chat History. Please contact Unity Support for feature enablement.")]
IReadOnlyQueue<IAccountArchiveMessage> AccountArchive { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyQueue<IAccountArchiveMessage> |
Remarks
Use the IReadOnlyQueue events to get notifications of incoming messages from a account archive query. This is not automatically cleared when starting a new BeginAccountArchiveQuery.
AccountArchiveResult
The result set when all the messages have been returned from a BeginAccountArchiveQuery.
Declaration
[Obsolete("This feature is being deprecated in favor of the limited beta release of Chat History. Please contact Unity Support for feature enablement.")]
IArchiveQueryResult AccountArchiveResult { get; }Property Value
| Type | Description |
|---|---|
| IArchiveQueryResult |
Remarks
Use the PropertyChanged event to get notified when a account archive query has started or completed.
AllowedSubscriptions
The list of accounts allowed to see this account's online status.
Declaration
IReadOnlyHashSet<AccountId> AllowedSubscriptions { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyHashSet<AccountId> |
BlockedSubscriptions
The list of accounts blocked from seeing this account's online status.
Declaration
IReadOnlyHashSet<AccountId> BlockedSubscriptions { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyHashSet<AccountId> |
ChannelSessions
The list of channel sessions associated with this login session.
Declaration
IReadOnlyDictionary<ChannelId, IChannelSession> ChannelSessions { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<ChannelId, IChannelSession> |
CrossMutedCommunications
The list of accounts with cross muted communications to this LoginSession
Declaration
IReadOnlyHashSet<AccountId> CrossMutedCommunications { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyHashSet<AccountId> |
DirectedMessageResult
The result set when a user to user message has been sent.
Declaration
IDirectedMessageResult DirectedMessageResult { get; }Property Value
| Type | Description |
|---|---|
| IDirectedMessageResult |
Remarks
Use the PropertyChanged event to get notified when a directed message has been sent.
DirectedMessages
The list of incoming user to user messages.
Declaration
IReadOnlyQueue<IDirectedTextMessage> DirectedMessages { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyQueue<IDirectedTextMessage> |
FailedDirectedMessages
The list of failed user to user messages.
Declaration
IReadOnlyQueue<IFailedDirectedTextMessage> FailedDirectedMessages { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyQueue<IFailedDirectedTextMessage> |
IncomingSubscriptionRequests
The list of incoming subscription requests.
Declaration
IReadOnlyQueue<AccountId> IncomingSubscriptionRequests { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyQueue<AccountId> |
IsInjectingAudio
The current status of injected audio.
Declaration
bool IsInjectingAudio { get; }Property Value
| Type | Description |
|---|---|
| bool |
LoginSessionId
The unique identifier for this login session.
Declaration
AccountId LoginSessionId { get; }Property Value
| Type | Description |
|---|---|
| AccountId |
ParticipantPropertyFrequency
Specifies how often the SDK will send participant property events while in a channel.
Declaration
ParticipantPropertyUpdateFrequency ParticipantPropertyFrequency { get; set; }Property Value
| Type | Description |
|---|---|
| ParticipantPropertyUpdateFrequency |
Remarks
Only use this property to set the update frequency before login. After login, the BeginAccountSetLoginProperties(ParticipantPropertyUpdateFrequency, AsyncCallback) call must be used.
Participant property events by default are only sent on participant state change (starts talking, stops talking, is muted, is unmuted). If set to a per second rate, messages will be sent at that rate if there has been a change since the last update message. This is always true unless the participant is muted through the SDK, causing no audio energy and no state changes.
WARNING: Setting this value a non-default value will increase user and server traffic. It should only be done if a real-time visual representation of audio values are needed (e.g., graphic VAD indicator). For a static VAD indicator, the default setting is correct.
Presence
The online status that is sent to those accounts subscribing to the presence of this account.
Declaration
Presence Presence { get; set; }Property Value
| Type | Description |
|---|---|
| Presence |
PresenceSubscriptions
The list of presence subscriptions associated with this login session.
Declaration
IReadOnlyDictionary<AccountId, IPresenceSubscription> PresenceSubscriptions { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<AccountId, IPresenceSubscription> |
Remarks
This typically corresponds to a list of "friends".
RecoveryState
The current state of the connection recovery process.
Declaration
ConnectionRecoveryState RecoveryState { get; }Property Value
| Type | Description |
|---|---|
| ConnectionRecoveryState |
State
The current state of this login session.
Declaration
LoginState State { get; }Property Value
| Type | Description |
|---|---|
| LoginState |
TTS
The text-to-speech subsystem instance that is associated with this Login session.
Declaration
ITextToSpeech TTS { get; }Property Value
| Type | Description |
|---|---|
| ITextToSpeech |
TransmissionType
Get the transmission policy set for the player.
Declaration
TransmissionMode TransmissionType { get; }Property Value
| Type | Description |
|---|---|
| TransmissionMode |
TransmittingChannels
Get all channels transmitting channels.
Declaration
ReadOnlyCollection<ChannelId> TransmittingChannels { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<ChannelId> |
Methods
BeginAccountArchiveQuery(DateTime?, DateTime?, string, AccountId, ChannelId, uint, string, string, int, AsyncCallback)
Start a query of archived directed messages.
Declaration
[Obsolete("This feature is being deprecated in favor of the limited beta release of Chat History. Please contact Unity Support for feature enablement.")]
IAsyncResult BeginAccountArchiveQuery(DateTime? timeStart, DateTime? timeEnd, string searchText, AccountId userId, ChannelId channel, uint max, string afterId, string beforeId, int firstMessageIndex, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime? | timeStart | Results filtering: Only messages on or after the given date/time will be returned. For no start limit, use null. |
| DateTime? | timeEnd | Results filtering: Only messages before the given date/time will be returned. For no end limit, use null. |
| string | searchText | Results filtering: Only messages containing the specified text will be returned. For order matching, use double-quotes around the search terms. For no text filtering, use null. |
| AccountId | userId | Results filtering: Only messages to/from the specified participant will be returned. If this parameter is set, channel must be null. For no participant filtering, use null. |
| ChannelId | channel | Results filtering: Only messages to/from the specified channel will be returned. If this parameter is set, userId must be null. For no channel filtering, use null. |
| uint | max | Results paging: The maximum number of messages to return (up to 50). If more than 50 messages are needed, multiple queries must be performed. Use 0 to get total messages count without retrieving them. |
| string | afterId | Results paging: Only messages following the specified message id will be returned in the result set. If this parameter is set, beforeId must be null. For no lower limit, use null. |
| string | beforeId | Results paging: Only messages preceding the specified message id will be returned in the result set. If this parameter is set, afterId must be null. For no upper limit, use null. |
| int | firstMessageIndex | Results paging: The server side index (not message ID) of the first message to retrieve. The first message in the result set always has an index of 0. For no starting message, use -1. |
| AsyncCallback | callback | A delegate to call when this operation completes. |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when max value too large. |
| ArgumentException | Thrown when afterId and beforeId are used at the same time. |
| ArgumentException | Thrown when userId and channel are used at the same time. |
BeginAccountSetLoginProperties(ParticipantPropertyUpdateFrequency, AsyncCallback)
Called to change login properties when already logged in
Declaration
IAsyncResult BeginAccountSetLoginProperties(ParticipantPropertyUpdateFrequency participantPropertyFrequency, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| ParticipantPropertyUpdateFrequency | participantPropertyFrequency | How often the SDK will send participant property events while in a channel |
| AsyncCallback | callback | A delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
Remarks
Only use this property to set the update frequency after login. Before login, the ParticipantPropertyFrequency property must be used.
Participant property events by default are only sent on participant state change (starts talking, stops talking, is muted, is unmuted). If set to a per second rate, messages will be sent at that rate if there has been a change since the last update message. This is always true unless the participant is muted through the SDK, causing no audio energy and no state changes.
WARNING: Setting this value a non-default value will increase user and server traffic. It should only be done if a real-time visual representation of audio values are needed (e.g., graphic VAD indicator). For a static VAD indicator, the default setting is correct.
BeginAddAllowedSubscription(AccountId, AsyncCallback)
Allow incoming subscription requests from the specified account
Declaration
IAsyncResult BeginAddAllowedSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to allow |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
BeginAddBlockedSubscription(AccountId, AsyncCallback)
Block incoming subscription requests from the specified account
Declaration
IAsyncResult BeginAddBlockedSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to block |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
BeginAddPresenceSubscription(AccountId, AsyncCallback)
Subscribe to the specified account
Declaration
IAsyncResult BeginAddPresenceSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to subscribe to |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
Remarks
This method will automatically allow accountId to see the subscriber's online status
BeginLogin(string, SubscriptionMode, IReadOnlyHashSet<AccountId>, IReadOnlyHashSet<AccountId>, IReadOnlyHashSet<AccountId>, AsyncCallback)
Begin logging in this session when presence (subscriptions) are desired.
Declaration
IAsyncResult BeginLogin(string accessToken, SubscriptionMode subscriptionMode, IReadOnlyHashSet<AccountId> presenceSubscriptions, IReadOnlyHashSet<AccountId> blockedPresenceSubscriptions, IReadOnlyHashSet<AccountId> allowedPresenceSubscriptions, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| string | accessToken | an access token provided by your game server that enables this login. |
| SubscriptionMode | subscriptionMode | how to handle incoming subscriptions. |
| IReadOnlyHashSet<AccountId> | presenceSubscriptions | A list of accounts for which this user wishes to monitor online status. |
| IReadOnlyHashSet<AccountId> | blockedPresenceSubscriptions | A list of accounts that are not allwed to see this user's online status. |
| IReadOnlyHashSet<AccountId> | allowedPresenceSubscriptions | A list of accounts that are allowed to see this user's online status. |
| AsyncCallback | callback | a delegate to call when this operation completes. |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
Remarks
This version of BeginLogin does not require a Uri server argument. It is intended to be used with Unity Game Services. If you are manually initializing Vivox, please continue to use BeginLogin signature that requires the Uri server argument. Developer of games that do not have secure communications requirements can use GetLoginToken(TimeSpan?) to generate the required access token.
BeginLogin(Uri, string, AsyncCallback)
Begin logging in this session for text and voice only (no subscriptions possible).
Declaration
IAsyncResult BeginLogin(Uri server, string accessToken, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| Uri | server | The URI of the Vivox instance assigned to you |
| string | accessToken | an access token provided by your game server that enables this login |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
Remarks
Developer of games that do not have secure communications requirements can use GetLoginToken(TimeSpan?) to generate the required access token.
BeginLogin(Uri, string, SubscriptionMode, IReadOnlyHashSet<AccountId>, IReadOnlyHashSet<AccountId>, IReadOnlyHashSet<AccountId>, AsyncCallback)
Begin logging in this session when presence (subscriptions) are desired.
Declaration
IAsyncResult BeginLogin(Uri server, string accessToken, SubscriptionMode subscriptionMode, IReadOnlyHashSet<AccountId> presenceSubscriptions, IReadOnlyHashSet<AccountId> blockedPresenceSubscriptions, IReadOnlyHashSet<AccountId> allowedPresenceSubscriptions, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| Uri | server | The URI of the Vivox instance assigned to you. |
| string | accessToken | an access token provided by your game server that enables this login. |
| SubscriptionMode | subscriptionMode | how to handle incoming subscriptions. |
| IReadOnlyHashSet<AccountId> | presenceSubscriptions | A list of accounts for which this user wishes to monitor online status. |
| IReadOnlyHashSet<AccountId> | blockedPresenceSubscriptions | A list of accounts that are not allwed to see this user's online status. |
| IReadOnlyHashSet<AccountId> | allowedPresenceSubscriptions | A list of accounts that are allowed to see this user's online status. |
| AsyncCallback | callback | a delegate to call when this operation completes. |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
Remarks
Developer of games that do not have secure communications requirements can use GetLoginToken(TimeSpan?) to generate the required access token.
BeginRemoveAllowedSubscription(AccountId, AsyncCallback)
Disallow incoming subscription requests from the specified account. Subscription requests from the specified account will cause an event to be raised to the application.
Declaration
IAsyncResult BeginRemoveAllowedSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to disallow |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
BeginRemoveBlockedSubscription(AccountId, AsyncCallback)
Unblock incoming subscription requests from the specified account. Subscription requests from the specified account will cause an event to be raised to the application.
Declaration
IAsyncResult BeginRemoveBlockedSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to unblock |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
BeginRemovePresenceSubscription(AccountId, AsyncCallback)
Unsubscribe from the specified account
Declaration
IAsyncResult BeginRemovePresenceSubscription(AccountId accountId, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the account id to subscribe to |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | IAsyncResult |
BeginSendDirectedMessage(AccountId, string, AsyncCallback)
Send a message to the specific account
Declaration
IAsyncResult BeginSendDirectedMessage(AccountId accountId, string message, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the intended recipient of the message |
| string | message | the body of the message |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult |
BeginSendDirectedMessage(AccountId, string, string, string, string, AsyncCallback)
Send a message to the specific account
Declaration
IAsyncResult BeginSendDirectedMessage(AccountId accountId, string language, string message, string applicationStanzaNamespace, string applicationStanzaBody, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | the intended recipient of the message |
| string | language | the language of the message e.g "en". This can be null to use the default language ("en" for most systems). This must conform to RFC5646 (https://tools.ietf.org/html/rfc5646) |
| string | message | the body of the message |
| string | applicationStanzaNamespace | an optional namespace element for additional application data |
| string | applicationStanzaBody | the additional application data body |
| AsyncCallback | callback | a delegate to call when this operation completes |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult |
ClearCrossMutedCommunications(AsyncCallback)
Clear the bi-directionally muted communications list, unmuting all AccountIds and allowing audio/text through any way not otherwise prevented
Declaration
IAsyncResult ClearCrossMutedCommunications(AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AsyncCallback | callback |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult. |
DeleteChannelSession(ChannelId)
Deletes the channel session for this channelId, disconnecting the session if necessary
Declaration
void DeleteChannelSession(ChannelId channelId)Parameters
| Type | Name | Description |
|---|---|---|
| ChannelId | channelId | the id of the channel |
EndAccountArchiveQuery(IAsyncResult)
To be called by the consumer of this class when BeginArchiveArchiveQuery() completes.
Declaration
[Obsolete("This feature is being deprecated in favor of the limited beta release of Chat History. Please contact Unity Support for feature enablement.")]
void EndAccountArchiveQuery(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginAccountArchiveQuery() or provided to the callback delegate. |
EndAccountSetLoginProperties(IAsyncResult)
To be called by the consumer of this class when BeginAccountSetLoginProperties() completes.
Declaration
void EndAccountSetLoginProperties(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginAccountSetLoginProperties() or provided to the callback delegate |
EndAddAllowedSubscription(IAsyncResult)
To be called by the consumer of this class when BeginAddAllowedSubscription() completes.
Declaration
void EndAddAllowedSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginAddAllowedSubscription() or provided to the callback delegate |
EndAddBlockedSubscription(IAsyncResult)
To be called by the consumer of this class when BeginAddBlockedSubscription() completes.
Declaration
void EndAddBlockedSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginAddBlockedSubscription() or provided to the callback delegate |
EndAddPresenceSubscription(IAsyncResult)
To be called by the consumer of this class when BeginAddPresenceSubscription() completes.
Declaration
IPresenceSubscription EndAddPresenceSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginAddPresenceSubscription() or provided to the callback delegate |
Returns
| Type | Description |
|---|---|
| IPresenceSubscription | The presence subscription for the account id |
EndLogin(IAsyncResult)
To be called by the consumer of this class when BeginLogin() completes.
Declaration
void EndLogin(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginLogin() or provided to the callback delegate |
EndRemoveAllowedSubscription(IAsyncResult)
To be called by the consumer of this class when BeginRemoveAllowedSubscription() completes.
Declaration
void EndRemoveAllowedSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginRemoveAllowedSubscription() or provided to the callback delegate |
EndRemoveBlockedSubscription(IAsyncResult)
To be called by the consumer of this class when BeginRemoveBlockedSubscription() completes.
Declaration
void EndRemoveBlockedSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginRemoveBlockedSubscription() or provided to the callback delegate |
EndRemovePresenceSubscription(IAsyncResult)
To be called by the consumer of this class when BeginRemovePresenceSubscription() completes.
Declaration
void EndRemovePresenceSubscription(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginRemovePresenceSubscription() or provided to the callback delegate |
EndSendDirectedMessage(IAsyncResult)
To be called by the consumer of this class when BeginSendDirectedMessage() completes.
Declaration
void EndSendDirectedMessage(IAsyncResult result)Parameters
| Type | Name | Description |
|---|---|---|
| IAsyncResult | result | The IAsyncResult object returned from BeginSendDirectedMessage() or provided to the callback delegate |
GetChannelSession(ChannelId)
Gets the channel session for this channelId, creating one if necessary
Declaration
IChannelSession GetChannelSession(ChannelId channelId)Parameters
| Type | Name | Description |
|---|---|---|
| ChannelId | channelId | the id of the channel |
Returns
| Type | Description |
|---|---|
| IChannelSession | the channel session |
GetLoginToken(TimeSpan?)
Get a login token for this account.
Declaration
string GetLoginToken(TimeSpan? tokenExpirationDuration = null)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan? | tokenExpirationDuration | the length of time the token is valid for - will default to 60 seconds |
Returns
| Type | Description |
|---|---|
| string | an access token that can be used to log this account in |
Remarks
To be used only by applications without secure communications requirements.
GetLoginToken(string, TimeSpan)
Get a login token for this account.
Declaration
string GetLoginToken(string tokenSigningKey, TimeSpan tokenExpirationDuration)Parameters
| Type | Name | Description |
|---|---|---|
| string | tokenSigningKey | |
| TimeSpan | tokenExpirationDuration | the length of time the token is valid for - will default to 60 seconds |
Returns
| Type | Description |
|---|---|
| string | an access token that can be used to log this account in |
Remarks
To be used only by applications without secure communications requirements.
Logout()
Log the account out of the Vivox system. This will not raise a property event for changing the State to LoginState.LoggedOut, although the state will be set to that upon completion of the function.
Declaration
void Logout()SetCrossMutedCommunications(List<AccountId>, bool, AsyncCallback)
"Cross mute" a set of AccountIds, bidirectionally muting audio/text between those accounts and this login session
Declaration
IAsyncResult SetCrossMutedCommunications(List<AccountId> accountIdSet, bool muted, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| List<AccountId> | accountIdSet | The set of AccountIds to bi-directionally mute or unmute |
| bool | muted | The status to set, with true as muted and false unmuted |
| AsyncCallback | callback |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult. |
SetCrossMutedCommunications(AccountId, bool, AsyncCallback)
"Cross mute" an AccountId, bidirectionally muting audio/text between that account and this login session
Declaration
IAsyncResult SetCrossMutedCommunications(AccountId accountId, bool muted, AsyncCallback callback)Parameters
| Type | Name | Description |
|---|---|---|
| AccountId | accountId | The AccountId to bi-directionally mute or unmute |
| bool | muted | The status to set, with true as muted and false unmuted |
| AsyncCallback | callback |
Returns
| Type | Description |
|---|---|
| IAsyncResult | The AsyncResult. |
SetTransmissionMode(TransmissionMode, ChannelId)
Set whether microphone audio and injected audio should be transmitted to no channels, all channels, or a single specific channel.
Declaration
void SetTransmissionMode(TransmissionMode mode, ChannelId singleChannel = null)Parameters
| Type | Name | Description |
|---|---|---|
| TransmissionMode | mode | enum specifying a transmission policy |
| ChannelId | singleChannel | the specific channel to transmit to when TransmissionMode::Single is set (ignored otherwise) |
Remarks
To be used only by applications without secure communications requirements.
StartAudioInjection(string)
This function allows you to start audio injection
Declaration
void StartAudioInjection(string audioFilePath)Parameters
| Type | Name | Description |
|---|---|---|
| string | audioFilePath | The full pathname for the WAV file to use for audio injection (MUST be single channel, 16-bit PCM, with the same sample rate as the negotiated audio codec) required for start |
StopAudioInjection()
This function allows you to stop audio injection
Declaration
void StopAudioInjection()