Package com.azure.android.communication.calling

Class CallClient

  • public final class CallClient
extends Object
    This is the main class representing the entrypoint for the Calling SDK.

    • Constructor Summary

      Constructors 
      Constructor Description
      CallClient()
      Creates a new instance with a default configuration
      CallClient​(CallClientOptions options)
      Creates a new instance with CallClientOptions

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CompletableFuture<CallAgent> createCallAgent​(Context appContext, CommunicationTokenCredential communicationTokenCredential)
      Factory method for creating a CallAgent.
      CompletableFuture<CallAgent> createCallAgent​(Context appContext, CommunicationTokenCredential communicationTokenCredential, CallAgentOptions callAgentOptions)
      Factory method for creating a CallAgent.
      CompletableFuture<TeamsCallAgent> createTeamsCallAgent​(Context appContext, CommunicationTokenCredential communicationTokenCredential)
      Factory method for creating a TeamsCallAgent.
      CompletableFuture<TeamsCallAgent> createTeamsCallAgent​(Context appContext, CommunicationTokenCredential communicationTokenCredential, TeamsCallAgentOptions teamsCallAgentOptions)
      Factory method for creating a TeamsCallAgent.
      void dispose()
      Releases all the resources held by CallAgent.
      protected void finalize()
      Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
      CallDebugInfo getDebugInfo()
      Retrieves the DebugInfo class, which is an interface to Debugging/Support helpers such as retrieving files for support
      CompletableFuture<DeviceManager> getDeviceManager​(Context context)
      Gets a device manager object that can be used to enumerates audio and video devices available for calls.

      • Methods inherited from class Object

        clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CallClient

        public CallClient()
        Creates a new instance with a default configuration

      • CallClient

        public CallClient​(CallClientOptions options)
        Creates a new instance with CallClientOptions

    • Method Detail

      • finalize

        protected void finalize()
        Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
        Overrides:
        finalize in class Object

      • getDebugInfo

        public CallDebugInfo getDebugInfo()
        Retrieves the DebugInfo class, which is an interface to Debugging/Support helpers such as retrieving files for support

      • dispose

        public void dispose()
        Releases all the resources held by CallAgent. CallAgent should be destroyed/nullified after dispose.

      • getDeviceManager

        public CompletableFuture<DeviceManager> getDeviceManager​(Context context)
        Gets a device manager object that can be used to enumerates audio and video devices available for calls.
        Parameters:
        context - context object from application
        Returns:
        The DeviceManager object to manage video devices for calls.

      • createCallAgent

        public CompletableFuture<CallAgent> createCallAgent​(Context appContext,
                                                    CommunicationTokenCredential communicationTokenCredential,
                                                    CallAgentOptions callAgentOptions)
        Factory method for creating a CallAgent.
        Parameters:
        appContext - Context object for initialization purposes. Determine log file path, etc.
        communicationTokenCredential - Object to manages user authentication token retrieval
        callAgentOptions - Options for creating CallAgent
        Returns:
        The CallAgent object to manage calls for the authenticated user.

      • createCallAgent

        public CompletableFuture<CallAgent> createCallAgent​(Context appContext,
                                                    CommunicationTokenCredential communicationTokenCredential)
        Factory method for creating a CallAgent.
        Parameters:
        appContext - Context object for initialization purposes. Determine log file path, etc.
        communicationTokenCredential - Object to manages user authentication token retrieval
        Returns:
        The CallAgent object to manage calls for the authenticated user.

      • createTeamsCallAgent

        public CompletableFuture<TeamsCallAgent> createTeamsCallAgent​(Context appContext,
                                                              CommunicationTokenCredential communicationTokenCredential,
                                                              TeamsCallAgentOptions teamsCallAgentOptions)
        Factory method for creating a TeamsCallAgent.
        Parameters:
        appContext - Context object for initialization purposes. Determine log file path, etc.
        communicationTokenCredential - Object to manages user authentication token retrieval
        Returns:
        The TeamsCallAgent object to manage calls for the authenticated user.

      • createTeamsCallAgent

        public CompletableFuture<TeamsCallAgent> createTeamsCallAgent​(Context appContext,
                                                              CommunicationTokenCredential communicationTokenCredential)
        Factory method for creating a TeamsCallAgent.
        Parameters:
        appContext - Context object for initialization purposes. Determine log file path, etc.
        communicationTokenCredential - Object to manages user authentication token retrieval
        Returns:
        The TeamsCallAgent object to manage calls for the authenticated user.