Rate this page:

ICall

Interface that may be used for call operations like answer, reject, hang up and mid-call operations like hold, start/stop video and others.

Methods

Answer

Copy URL

void

Answer(

CallSettings

callSettings
)

Answer the incoming call.

Parameters

  • callSettings:

    CallSettings

    Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.

Returns

  • type:

    void

Hangup

Copy URL

void

Hangup(

IDictionary<string,string>

headers
)

Terminate the call. Call should be either established or outgoing progressing.

Parameters

  • headers:

    IDictionary<string,string>

    Optional set of headers to be sent. Names must begin with "X-" to be processed by SDK.

Returns

  • type:

    void

Hold

Copy URL

void

Hold(

bool

hold,

Action<Error?>

completion
)

Hold or unhold the call.

Parameters

  • hold:

    bool

    True if the call should be put on hold, false for unhold.

  • completion:

    Action<Error?>

    System.Action to handle the result of the operation.

Returns

  • type:

    void

ReceiveVideo

Copy URL

void

ReceiveVideo(

Action<Error?>

completion
)

Start receive video if video receive was disabled before. Stop receiving video during the call is not supported.

Parameters

  • completion:

    Action<Error?>

    System.Action to handle the result of the operation.

Returns

  • type:

    void

Reject

Copy URL

void

Reject(

RejectMode

rejectMode,

IDictionary<string,string>

headers
)

Reject the incoming call.

Parameters

  • rejectMode:

    RejectMode

    Specify mode of call rejection.

  • headers:

    IDictionary<string,string>

    Optional set of headers to be sent. Names must begin with "X-" to be processed by SDK.

Returns

  • type:

    void

SendAudio

Copy URL

void

SendAudio(

bool

sendAudio
)

Enable or disable audio transfer from microphone into the call.

Parameters

  • sendAudio:

    bool

    True if audio should be sent, false otherwise.

Returns

  • type:

    void

SendDTMF

Copy URL

void

SendDTMF(

string

dtmf
)

Send DTMF within the call.

Parameters

  • dtmf:

    string

    DTMFs.

Returns

  • type:

    void

SendInfo

Copy URL

void

SendInfo(

string

body,

string

mimeType,

IDictionary<string,string>

headers
)

Send INFO message within the call.

Parameters

  • body:

    string

    Custom string data.

  • mimeType:

    string

    MIME type of info.

  • headers:

    IDictionary<string,string>

    Optional set of headers to be sent. Names must begin with "X-" to be processed by SDK.

Returns

  • type:

    void

SendMessage

Copy URL

void

SendMessage(

string

message
)

Send a message within the call. Implemented atop SIP INFO for communication between call endpoint and the Voximplant cloud, and is separated from Voximplant messaging API.

Parameters

  • message:

    string

    Message text.

Returns

  • type:

    void

SendVideo

Copy URL

void

SendVideo(

bool

sendVideo,

Action<Error?>

completion
)

Start or stop sending video for the call.

Parameters

  • sendVideo:

    bool

    True if video should be sent, false otherwise.

  • completion:

    Action<Error?>

    System.Action to handle the result of the operation.

Returns

  • type:

    void

SetVideoSource

Copy URL

void

SetVideoSource(

UnityEngine.Camera

camera,

double

fps
)

Use UnityEngine.Camera instance for the call to send video frames. It will be used instead of the hardware camera.

Parameters

  • camera:

    UnityEngine.Camera

    Unity camera.

  • fps:

    double

    Video frame rate.

Returns

  • type:

    void

SetVideoSource

Copy URL

void

SetVideoSource(

UnityEngine.Camera

camera,

int

width,

int

height,

double

fps
)

Use UnityEngine.Camera instance for the call to send video frames. It will be used instead of the hardware camera.

Parameters

  • camera:

    UnityEngine.Camera

    Unity camera.

  • width:

    int

    Video frame width.

  • height:

    int

    Video frame height

  • fps:

    double

    Video frame rate.

Returns

  • type:

    void

Start

Copy URL

void

Start()

Start outgoing call.

Returns

  • type:

    void

Props

CallId

Copy URL

string

CallId { get; }

The identifier for the call.

Returns

  • type:

    string

Duration

Copy URL

ulong

Duration { get; }

The call duration.

Returns

  • type:

    ulong

Endpoints

Copy URL

IReadOnlyCollection<IEndpoint>

Endpoints { get; }

A collection of the endpoints associated with the call.

Returns

LocalVideoStreams

Copy URL

IReadOnlyCollection<IVideoStream>

LocalVideoStreams { get; }

The local video streams associated with the call.

Returns