Gestire la registrazione delle chiamate nel client

Importante

Attualmente la funzionalità descritta in questo articolo è disponibile in anteprima pubblica. Questa versione di anteprima viene fornita senza contratto di servizio, pertanto se ne sconsiglia l’uso per i carichi di lavoro in ambienti di produzione. Alcune funzionalità potrebbero non essere supportate o potrebbero presentare funzionalità limitate. Per altre informazioni, vedere le Condizioni supplementari per l'uso delle anteprime di Microsoft Azure.

La registrazione delle chiamate consente agli utenti di registrare le chiamate effettuate con Servizi di comunicazione di Azure. Questo articolo illustra come gestire la registrazione sul lato client. Prima di iniziare, è necessario configurare la registrazione sul lato server.

Prerequisiti

• Un account Azure con una sottoscrizione attiva. Creare un account gratuitamente.
• Una risorsa di Servizi di comunicazione distribuita. Creare una risorsa di Servizi di comunicazione.
• Token di accesso utente per abilitare il client chiamante. Per altre informazioni, vedere Creare e gestire i token di accesso.
• Facoltativo: completamento della guida introduttiva per aggiungere chiamate vocali all'applicazione.

Installazione dell'SDK

Usare il comando npm install per installare SDK comuni e di chiamata di Servizi di comunicazione di Azure per JavaScript:

npm install @azure/communication-common --save
npm install @azure/communication-calling --save

Inizializzare gli oggetti necessari

Per la maggior parte delle operazioni di chiamata è necessaria un'istanza di CallClient. Quando si crea una nuova istanza di CallClient, è possibile configurarla con opzioni personalizzate come un'istanza di Logger.

Con l'istanza di CallClient è possibile creare un'istanza di CallAgent chiamando il createCallAgent. Questo metodo restituisce in modo asincrono un oggetto istanza CallAgent.

Il metodo createCallAgent usa CommunicationTokenCredential come argomento. Accetta un token di accesso utente.

È possibile usare il metodo getDeviceManager nell'istanza di CallClient per accedere a deviceManager.

const { CallClient } = require('@azure/communication-calling');
const { AzureCommunicationTokenCredential} = require('@azure/communication-common');
const { AzureLogger, setLogLevel } = require("@azure/logger");

// Set the logger's log level
setLogLevel('verbose');

// Redirect log output to console, file, buffer, REST API, or whatever location you want
AzureLogger.log = (...args) => {
    console.log(...args); // Redirect log output to console
};

const userToken = '<USER_TOKEN>';
callClient = new CallClient(options);
const tokenCredential = new AzureCommunicationTokenCredential(userToken);
const callAgent = await callClient.createCallAgent(tokenCredential, {displayName: 'optional Azure Communication Services user name'});
const deviceManager = await callClient.getDeviceManager()

Come gestire al meglio la connettività dell'SDK all'infrastruttura Microsoft

L'istanza Call Agent consente di gestire le chiamate (per partecipare o avviare le chiamate). Per lavorare con l'SDK per chiamate, è necessario connettersi all'infrastruttura Microsoft per ricevere notifiche delle chiamate in arrivo e coordinare altri dettagli delle chiamate. Call Agent ha due possibili stati:

Connesso : un valore connectionStatue Call Agent di Connected indica che l'SDK client è connesso e in grado di ricevere notifiche dall'infrastruttura Microsoft.

Disconnesso : un valore connectionStatue Call Agent di Disconnected indica un problema che impedisce all'SDK di connettersi correttamente. Call Agent deve essere ricreato.

• invalidToken: se un token è scaduto o non è valido l'istanza Call Agent si disconnette con questo errore.
• connectionIssue: se si verifica un problema con il client che si connette a Microsoft infrascture, dopo molti tentativi Call Agent espone l'errore connectionIssue.

È possibile verificare se l'infrastruttura locale Call Agent è connessa all'infrastruttura Microsoft controllando il valore corrente della proprietà connectionState. Durante una chiamata attiva è possibile restare in ascolto dell'evento connectionStateChanged per determinare se Call Agent cambia dallo stato Connesso a Disconnesso.

const connectionState = callAgentInstance.connectionState;
console.log(connectionState); // it may return either of 'Connected' | 'Disconnected'

const connectionStateCallback = (args) => {
    console.log(args); // it will return an object with oldState and newState, each of having a value of either of 'Connected' | 'Disconnected'
    // it will also return reason, either of 'invalidToken' | 'connectionIssue'
}
callAgentInstance.on('connectionStateChanged', connectionStateCallback);

Nota

Questa API viene fornita come anteprima per gli sviluppatori e può cambiare in base al feedback ricevuto. Non usare questa API in un ambiente di produzione. Per usare questa API, usare la versione beta di Servizi di comunicazione di Azure Calling Web SDK.

Registrazione nel cloud

La registrazione delle chiamate è una funzionalità estesa dell'API di chiamata principale. È prima necessario importare le funzionalità di chiamata da Calling SDK:

import { Features} from "@azure/communication-calling";

È quindi possibile ottenere l'oggetto API delle funzionalità di registrazione dall'istanza di chiamata:

const callRecordingApi = call.feature(Features.Recording);

Per verificare se la chiamata viene registrata, controllare la isRecordingActive proprietà di callRecordingApi. Restituisce Boolean.

const isRecordingActive = callRecordingApi.isRecordingActive;

È anche possibile sottoscrivere la registrazione delle modifiche:

const isRecordingActiveChangedHandler = () => {
    console.log(callRecordingApi.isRecordingActive);
};

callRecordingApi.on('isRecordingActiveChanged', isRecordingActiveChangedHandler);

È possibile ottenere un elenco di registrazioni usando la recordings proprietà di callRecordingApi. Restituisce RecordingInfo[], che ha lo stato corrente della registrazione cloud.

const recordings = callRecordingApi.recordings;

recordings.forEach(r => {
    console.log("State: ${r.state}");

È anche possibile sottoscrivere recordingsUpdated e ottenere una raccolta di registrazioni aggiornate. Questo evento viene attivato ogni volta che è presente un aggiornamento della registrazione.

const cloudRecordingsUpdatedHandler = (args: { added: SDK.RecordingInfo[], removed: SDK.RecordingInfo[]}) => {
                        console.log('Recording started by: ');
                        args.added?.forEach(a => {
                            console.log('State: ${a.state}');
                        });

                        console.log('Recording stopped by: ');
                        args.removed?.forEach(r => {
                            console.log('State: ${r.state}');
                        });
                    };
callRecordingApi.on('recordingsUpdated', cloudRecordingsUpdatedHandler );

Installazione dell'SDK

Individuare il file a livello build.gradle di progetto e aggiungere mavenCentral() all'elenco dei repository in buildscript e allprojects:

buildscript {
    repositories {
    ...
        mavenCentral()
    ...
    }
}

allprojects {
    repositories {
    ...
        mavenCentral()
    ...
    }
}

Quindi, nel file a livello build.gradle di modulo aggiungere le righe seguenti alla dependencies sezione :

dependencies {
    ...
    implementation 'com.azure.android:azure-communication-calling:1.0.0'
    ...
}

Inizializzare gli oggetti necessari

Per creare un'istanza CallAgent, è necessario chiamare il metodo createCallAgent in un'istanza CallClient. Questa chiamata restituisce in modo asincrono un oggetto istanza CallAgent.

Il metodo createCallAgent accetta CommunicationUserCredential come argomento, che incapsula un token di accesso.

Per accedere a DeviceManager, è prima necessario creare un'istanza callAgent. Quindi è possibile usare il metodo CallClient.getDeviceManager per ottenere DeviceManager.

String userToken = '<user token>';
CallClient callClient = new CallClient();
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(userToken);
android.content.Context appContext = this.getApplicationContext(); // From within an activity, for instance
CallAgent callAgent = callClient.createCallAgent(appContext, tokenCredential).get();
DeviceManager deviceManager = callClient.getDeviceManager(appContext).get();

Per impostare nome visualizzato per il chiamante, usare questo metodo alternativo:

String userToken = '<user token>';
CallClient callClient = new CallClient();
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(userToken);
android.content.Context appContext = this.getApplicationContext(); // From within an activity, for instance
CallAgentOptions callAgentOptions = new CallAgentOptions();
callAgentOptions.setDisplayName("Alice Bob");
DeviceManager deviceManager = callClient.getDeviceManager(appContext).get();
CallAgent callAgent = callClient.createCallAgent(appContext, tokenCredential, callAgentOptions).get();

Registrare le chiamate

Nota

Questa API viene fornita come anteprima per gli sviluppatori e può cambiare in base al feedback ricevuto. Non usare questa API in un ambiente di produzione. Per usare questa API, usare la versione beta di Servizi di comunicazione di Azure Calling Android SDK.

La registrazione delle chiamate è una funzionalità estesa dell'oggetto principale Call .

Avviso

Fino alla versione 1.1.0 e alla versione beta 1.1.0-beta.1 del Servizi di comunicazione di Azure Calling Android SDK isRecordingActive e addOnIsRecordingActiveChangedListener facevano parte dell'oggetto Call . Per le nuove versioni beta, tali API sono state spostate come funzionalità estesa di Call.

È prima necessario ottenere l'oggetto funzionalità di registrazione:

RecordingCallFeature callRecordingFeature = call.feature(Features.RECORDING);

Quindi, per verificare se la chiamata viene registrata, controllare la isRecordingActive proprietà di callRecordingFeature. Restituisce boolean.

boolean isRecordingActive = callRecordingFeature.isRecordingActive();

È anche possibile sottoscrivere la registrazione delle modifiche:

private void handleCallOnIsRecordingChanged(PropertyChangedEvent args) {
  boolean isRecordingActive = callRecordingFeature.isRecordingActive();
}

callRecordingFeature.addOnIsRecordingActiveChangedListener(handleCallOnIsRecordingChanged);

Se vuoi avviare la registrazione dall'applicazione, segui prima di tutto la panoramica della registrazione delle chiamate per la procedura per configurare la registrazione delle chiamate.

Dopo aver configurato la registrazione delle chiamate sul server, dall'applicazione Android è necessario ottenere il ServerCallId valore dalla chiamata e quindi inviarlo al server per avviare il processo di registrazione. È possibile trovare il ServerCallId valore usando getServerCallId() dalla CallInfo classe . È possibile trovare la CallInfo classe nell'oggetto classe usando getInfo().

try {
    String serverCallId = call.getInfo().getServerCallId().get();
    // Send serverCallId to your recording server to start the call recording.
} catch (ExecutionException | InterruptedException e) {

} catch (UnsupportedOperationException unsupportedOperationException) {

}

Quando si avvia la registrazione dal server, l'evento handleCallOnIsRecordingChanged viene attivato e il valore di callRecordingFeature.isRecordingActive() è true.

Proprio come l'avvio della registrazione delle chiamate, se vuoi arrestare la registrazione delle chiamate, devi ottenerla ServerCallId e inviarla al server di registrazione in modo che possa arrestare la registrazione:

try {
    String serverCallId = call.getInfo().getServerCallId().get();
    // Send serverCallId to your recording server to stop the call recording.
} catch (ExecutionException | InterruptedException e) {

} catch (UnsupportedOperationException unsupportedOperationException) {

}

Quando si arresta la registrazione dal server, l'evento handleCallOnIsRecordingChanged viene attivato e il valore di callRecordingFeature.isRecordingActive() è false.

Configurare il sistema

Seguire questa procedura per configurare il sistema.

Creare il progetto Xcode

In Xcode creare un nuovo progetto iOS e selezionare il modello Single View Application. Questo articolo usa il framework SwiftUI, quindi è consigliabile impostare Language su Swift e impostare Interface su SwiftUI.

In questo articolo non verranno creati test. È possibile deselezionare la casella di controllo Includi i test.

Installare il pacchetto e le dipendenze usando CocoaPods

1. Creare un file Podfile per l'applicazione, come questo esempio:

   platform :ios, '13.0'
   use_frameworks!
   target 'AzureCommunicationCallingSample' do
       pod 'AzureCommunicationCalling', '~> 1.0.0'
   end
   

2. Eseguire pod install.

3. Aprire .xcworkspace con Xcode.

Richiedere l'accesso al microfono

Per accedere al microfono del dispositivo, è necessario aggiornare l'elenco delle proprietà informazioni dell'app usando NSMicrophoneUsageDescription. Impostare il valore associato su una stringa inclusa nella finestra di dialogo usata dal sistema per richiedere l'accesso dall'utente.

Fare clic con il pulsante destro del mouse sulla voce info.plist dell'albero del progetto, quindi selezionare Apri come>codice sorgente. Aggiungere le righe seguenti nella sezione di primo livello <dict> e quindi salvare il file.

<key>NSMicrophoneUsageDescription</key>
<string>Need microphone access for VOIP calling.</string>

Configurare il framework dell'app

Aprire il file del ContentView.swift progetto. Aggiungere una dichiarazione import all'inizio del file per importare la libreria AzureCommunicationCalling. Inoltre, importare AVFoundation: È necessario per le richieste di autorizzazione audio nel codice.

import AzureCommunicationCalling
import AVFoundation

Inizializzare CallAgent

Per creare un'istanza CallAgent da CallClient, è necessario usare un metodo callClient.createCallAgent che restituisce in modo asincrono un oggetto CallAgent dopo l'inizializzazione.

Per creare un client di chiamata, passare un oggetto CommunicationTokenCredential:

import AzureCommunication

let tokenString = "token_string"
var userCredential: CommunicationTokenCredential?
do {
    let options = CommunicationTokenRefreshOptions(initialToken: token, refreshProactively: true, tokenRefresher: self.fetchTokenSync)
    userCredential = try CommunicationTokenCredential(withOptions: options)
} catch {
    updates("Couldn't created Credential object", false)
    initializationDispatchGroup!.leave()
    return
}

// tokenProvider needs to be implemented by Contoso, which fetches a new token
public func fetchTokenSync(then onCompletion: TokenRefreshOnCompletion) {
    let newToken = self.tokenProvider!.fetchNewToken()
    onCompletion(newToken, nil)
}

Passare l'oggetto CommunicationTokenCredential creato in CallClient e impostare il nome visualizzato:

self.callClient = CallClient()
let callAgentOptions = CallAgentOptions()
options.displayName = " iOS Azure Communication Services User"

self.callClient!.createCallAgent(userCredential: userCredential!,
    options: callAgentOptions) { (callAgent, error) in
        if error == nil {
            print("Create agent succeeded")
            self.callAgent = callAgent
        } else {
            print("Create agent failed")
        }
})

Registrare le chiamate

Nota

Questa API viene fornita come anteprima per gli sviluppatori e può cambiare in base al feedback ricevuto. Non usare questa API in un ambiente di produzione. Per usare questa API, usare la versione beta di Servizi di comunicazione di Azure Calling iOS SDK.

La registrazione delle chiamate è una funzionalità estesa dell'oggetto principale Call .

Avviso

Fino alla versione 1.1.0 e alla versione beta 1.1.0-beta.1 del Servizi di comunicazione di Azure Calling iOS SDK, isRecordingActive faceva parte dell'oggetto Call e didChangeRecordingState faceva parte del CallDelegate delegato. Per le nuove versioni beta, tali API sono state spostate come funzionalità estesa di Call.

È prima necessario ottenere l'oggetto funzionalità di registrazione:

let callRecordingFeature = call.feature(Features.recording)

Quindi, per verificare se la chiamata viene registrata, controllare la isRecordingActive proprietà di callRecordingFeature. Restituisce Bool.

let isRecordingActive = callRecordingFeature.isRecordingActive;

È anche possibile sottoscrivere la registrazione delle modifiche implementando il delegato nella RecordingCallFeatureDelegate classe con l'evento didChangeRecordingState:

callRecordingFeature.delegate = self

// didChangeRecordingState is a member of RecordingCallFeatureDelegate
public func recordingCallFeature(_ recordingCallFeature: RecordingCallFeature, didChangeRecordingState args: PropertyChangedEventArgs) {
    let isRecordingActive = recordingFeature.isRecordingActive
}

Se vuoi avviare la registrazione dall'applicazione, segui prima di tutto la panoramica della registrazione delle chiamate per la procedura per configurare la registrazione delle chiamate.

Dopo aver configurato la registrazione delle chiamate sul server, dall'applicazione iOS è necessario ottenere il ServerCallId valore dalla chiamata e quindi inviarlo al server per avviare il processo di registrazione. È possibile trovare il ServerCallId valore usando getServerCallId() dalla CallInfo classe . È possibile trovare la CallInfo classe nell'oggetto classe usando getInfo().

// Send serverCallId to your recording server to start the call recording.
let serverCallId = call.info.getServerCallId(){ (serverId, error) in }

Quando si avvia la registrazione dal server, l'evento didChangeRecordingState viene attivato e il valore di recordingFeature.isRecordingActive è true.

Proprio come l'avvio della registrazione delle chiamate, se vuoi arrestare la registrazione delle chiamate, devi ottenerla ServerCallId e inviarla al server di registrazione in modo che possa arrestare la registrazione:

// Send serverCallId to your recording server to stop the call recording.
let serverCallId = call.info.getServerCallId(){ (serverId, error) in }

Quando si arresta la registrazione dal server, l'evento didChangeRecordingState viene attivato e il valore di recordingFeature.isRecordingActive è false.

Configurare il sistema

Seguire questa procedura per configurare il sistema.

Creare il progetto di Visual Studio

Per un'app piattaforma UWP (Universal Windows Platform), in Visual Studio 2022 creare un nuovo progetto App vuota (Windows universale). Dopo aver immesso il nome del progetto, è possibile scegliere qualsiasi Windows SDK successivo alla versione 10.0.17763.0.

Per un'app WinUI 3, creare un nuovo progetto con il modello App vuota, Incluso nel pacchetto (WinUI 3 in Desktop) per configurare un'app WinUI 3 a pagina singola. È necessario SDK per app di Windows in versione 1.3 o successiva.

Installare il pacchetto e le dipendenze usando Gestione pacchetti NuGet

Le API e le librerie di SDK Chiamata sono disponibili pubblicamente tramite un pacchetto NuGet.

Per trovare, scaricare e installare il pacchetto NuGet Calling SDK:

1. Aprire Gestione pacchetti NuGet selezionando Strumenti>Gestione pacchetti NuGet> Gestisci pacchetti NuGet per la soluzione.
2. Selezionare Sfoglia e quindi immettere Azure.Communication.Calling.WindowsClient nella casella di ricerca.
3. Assicurarsi che la casella di controllo Includi versione preliminare sia selezionata.
4. Selezionare il pacchetto Azure.Communication.Calling.WindowsClient e quindi selezionare Azure.Communication.Calling.WindowsClient 1.4.0-beta.1 o una versione più recente.
5. Selezionare la casella di controllo corrispondente al progetto Servizi di comunicazione di Azure nel riquadro destro.
6. Selezionare Installa.

Registrare le chiamate

La registrazione delle chiamate è una funzionalità estesa dell'oggetto principale Call . È prima necessario ottenere l'oggetto funzionalità di registrazione:

RecordingCallFeature recordingFeature = call.Features.Recording;

Quindi, per verificare se la chiamata viene registrata, controllare la IsRecordingActive proprietà di recordingFeature. Restituisce boolean.

boolean isRecordingActive = recordingFeature.IsRecordingActive;

È anche possibile sottoscrivere la registrazione delle modifiche:

private async void Call__OnIsRecordingActiveChanged(object sender, PropertyChangedEventArgs args)
  boolean isRecordingActive = recordingFeature.IsRecordingActive;
}

recordingFeature.IsRecordingActiveChanged += Call__OnIsRecordingActiveChanged;

Registrazione della conformità

La registrazione della conformità è la registrazione basata sui criteri di Microsoft Teams. È possibile abilitarla usando questa esercitazione: Introduzione alla registrazione basata su criteri di Teams per le chiamate.

La registrazione basata su criteri viene avviata automaticamente quando un utente con i criteri partecipa a una chiamata. Per ottenere una notifica da Servizi di comunicazione di Azure sulla registrazione, usare il codice seguente:

const callRecordingApi = call.feature(Features.Recording);

const isComplianceRecordingActive = callRecordingApi.isRecordingActive;

const isComplianceRecordingActiveChangedHandler = () => {
    console.log(callRecordingApi.isRecordingActive);
};

callRecordingApi.on('isRecordingActiveChanged', isComplianceRecordingActiveChangedHandler);

È anche possibile implementare la registrazione della conformità usando un bot di registrazione personalizzato. Vedere l'esempio di GitHub.

Passaggi successivi

• Informazioni su come gestire le chiamate
• Informazioni su come gestire il video
• Informazioni su come trascrivere le chiamate