TVOCall Class Reference
Inherits from | NSObject |
---|---|
Declared in | TVOCall.h |
Overview
The TVOCall
class represents a bi-directional voice Call. TVOCall
objects are not created directly; they
are returned by [TVOCallInvite acceptWithOptions:delegate:]
or [TwilioVoice connectWithOptions:delegate:]
.
CallKit specific additions.
Properties
from
From
value of the Call.
@property (nonatomic, strong, readonly, nullable) NSString *from
Discussion
This may be nil
if the call object was created by calling the
[TwilioVoice connectWithOptions:delegate:]
method.
Declared In
TVOCall.h
to
To
value of the Call.
@property (nonatomic, strong, readonly, nullable) NSString *to
Discussion
This may be nil
if the call object was created by calling the
[TwilioVoice connectWithOptions:delegate:]
method.
Declared In
TVOCall.h
sid
A server assigned identifier (SID) for the Call.
@property (nonatomic, strong, readonly, nonnull) NSString *sid
Discussion
A SID is a globally unique identifier which can be very useful for debugging Call traffic. The Call sid
may be nil
until the call is in TVOCallStateRinging
state.
Declared In
TVOCall.h
muted
Property that defines if the Call is muted.
@property (nonatomic, assign, getter=isMuted) BOOL muted
Discussion
The Voice SDK’s media engine will start sending silent audio frames when the Call is muted. Setting the
property will only take effect if the state
is TVOCallStateConnected
.
Declared In
TVOCall.h
state
The current state of the Call.
@property (nonatomic, assign, readonly) TVOCallState state
Discussion
All TVOCall
instances start in TVOCallStateConnecting
and end in TVOCallStateDisconnected
.
After creation, a Call will transition to TVOCallStateConnected
if successful or TVOCallStateDisconnected
if the
connection attempt fails.
See Also
Declared In
TVOCall.h
onHold
Property that defines if the Call is on hold.
@property (nonatomic, getter=isOnHold) BOOL onHold
Discussion
If the Call is on hold, The Voice SDK’s media engine will send silent audio frames to the remote party, and remote party’s audio playback will be disabled.
Declared In
TVOCall.h
General Call Actions
– disconnect
Disconnects the Call.
- (void)disconnect
Discussion
Calling this method on a TVOCall
that is in the state
TVOCallStateDisconnected
has no effect.
Declared In
TVOCall.h
– sendDigits:
Send a string of digits.
- (void)sendDigits:(nonnull NSString *)digits
Parameters
digits |
A string of characters to be played. Valid values are ‘0’ - ‘9’, ‘*’, ‘#’, and ‘w’. Each ‘w’ will cause a 500 ms pause between digits sent. |
---|
Discussion
Calling this method on a TVOCall
that is not in the state
TVOCallStateConnected
has no effect.
Declared In
TVOCall.h
– getStatsWithBlock:
Retrieve stats for the audio track.
- (void)getStatsWithBlock:(nonnull TVOCallGetStatsBlock)block
Parameters
block |
The block to be invoked when the stats are available. |
---|
Declared In
TVOCall.h
– postFeedback:issue:
Posts the feedback collected for this Call to Twilio.
- (void)postFeedback:(TVOCallFeedbackScore)score issue:(TVOCallFeedbackIssue)issue
Parameters
score |
The quality score of the Call. |
---|---|
issue |
The issue associated with the Call. |
Discussion
If TVOCallFeedbackScoreNotReported
and TVOCallFeedbackIssueNotReported
are passed, Twilio will report feedback was not available for this call.
See Also
Declared In
TVOCall.h
CallKit Methods
uuid
A unique identifier for the Call.
@property (nonatomic, strong, readonly, nonnull) NSUUID *uuid
Discussion
Use this UUID as an argument to CallKit methods.
You can provide a UUID for outgoing calls using [TwilioVoice connectWithOptions:delegate:]
.
Calls created via [TVOCallInvite acceptWithOptions:delegate:]
inherit their uuid
from the Invite itself.
Declared In
TVOCall.h