pub enum CommandAction {
Show 55 variants
BeginCall {
line_instance: LineInstance,
call_id: CallId,
codec: Codec,
},
BeginTransfer {
source_call_id: CallId,
consultation_line_instance: LineInstance,
consultation_call_id: CallId,
codec: Codec,
},
SetCallInfo {
call_id: CallId,
info: CallInfo,
},
CommitOutboundCall {
call_id: CallId,
info: CallInfo,
},
PresentOutboundProceeding {
call_id: CallId,
info: CallInfo,
},
PresentOutboundRinging {
call_id: CallId,
info: CallInfo,
},
SetCallState {
call_id: CallId,
state: CallState,
},
SetCallSelected {
call_id: CallId,
selected: bool,
},
DisplayPrompt {
call_id: CallId,
timeout_seconds: u32,
text: String,
},
ClearPrompt {
call_id: CallId,
},
SetStatusMessage {
message: HandsetStatusMessage,
beep: bool,
},
SetMicrophoneMode {
enabled: bool,
},
SetRecordingStatus {
call_id: CallId,
active: bool,
},
ResetDevice {
reset_type: ResetType,
},
SetMwi {
line_instance: LineInstance,
enabled: bool,
},
SetForwardStatus {
line_instance: LineInstance,
forward_all: Option<String>,
forward_busy: Option<String>,
forward_no_answer: Option<String>,
},
SetFeatureStatus {
instance: LineInstance,
enabled: bool,
},
SetDoNotDisturbStatus {
instance: LineInstance,
mode: DoNotDisturbMode,
button_mode: DoNotDisturbButtonMode,
},
SetMobilityAppearance {
mobility_instance: LineInstance,
appearance: Option<LineAppearance>,
},
SetBlfStatus {
instance: LineInstance,
state: BlfState,
caller: Option<BlfCallerInfo>,
},
ShowParkingMenu {
instance: LineInstance,
transaction_id: TransactionId,
lot: String,
calls: Vec<ParkingMenuEntry>,
},
ShowConferenceList {
call_id: CallId,
conference_id: ConferenceId,
participants: Vec<ConferenceListEntry>,
},
ShowConferenceParticipantActions {
call_id: CallId,
conference_id: ConferenceId,
participant: ConferenceListEntry,
removable: bool,
demotable: bool,
},
ShowTextService {
line_instance: LineInstance,
call_reference: CallReference,
transaction_id: TransactionId,
priority: PhoneServicePriority,
document: CiscoIpPhoneText,
},
ShowInputService {
line_instance: LineInstance,
call_reference: CallReference,
application_id: ApplicationId,
transaction_id: TransactionId,
priority: PhoneServicePriority,
document: CiscoIpPhoneInput,
},
ExecutePhoneActions {
line_instance: LineInstance,
call_reference: CallReference,
application_id: ApplicationId,
transaction_id: TransactionId,
priority: PhoneServicePriority,
document: CiscoIpPhoneExecute,
},
ShowImageService {
line_instance: LineInstance,
call_reference: CallReference,
application_id: ApplicationId,
transaction_id: TransactionId,
priority: PhoneServicePriority,
document: PhoneImageDocument,
},
ShowStatusService {
line_instance: LineInstance,
call_reference: CallReference,
application_id: ApplicationId,
transaction_id: TransactionId,
priority: PhoneServicePriority,
document: PhoneStatusDocument,
},
SetBackgroundImage {
transaction_id: TransactionId,
document: CiscoIpPhoneSetBackground,
},
PreviewBackgroundImage {
transaction_id: TransactionId,
document: CiscoIpPhoneSetBackgroundPreview,
},
SetRingtone {
transaction_id: TransactionId,
document: CiscoIpPhoneSetRingTone,
},
StartTone {
call_id: CallId,
tone: Tone,
},
StartAnnouncement {
conference_id: ConferenceId,
announcements: Vec<AnnouncementEntry>,
end_of_ack: bool,
participant_ids: Vec<ParticipantId>,
hearing_participant_mask: u32,
play_mode: u32,
},
StopAnnouncement {
conference_id: ConferenceId,
},
AnnouncementFinish {
conference_id: ConferenceId,
play_status: u32,
},
StartRinging {
call_id: CallId,
},
StopRinging {
call_id: CallId,
},
OpenReceiveChannel {
call_id: CallId,
source: Option<MediaEndpoint>,
codec: Codec,
packet_ms: u32,
max_frames_per_packet: u32,
dtmf_mode: DtmfMode,
audio_processing: AudioProcessingPolicy,
},
OpenMultimediaReceiveChannel {
call_id: CallId,
descriptor: MultimediaReceiveDescriptor,
},
CloseMultimediaReceiveChannel {
call_id: CallId,
},
StartMultimediaTransmission {
call_id: CallId,
descriptor: MultimediaTransmitDescriptor,
},
StopMultimediaTransmission {
call_id: CallId,
},
SetMultimediaTransmitBitRate {
call_id: CallId,
passthrough_party_id: PassthroughPartyId,
maximum_bit_rate: u32,
},
NotifyMultimediaTransmitBitRate {
call_id: CallId,
passthrough_party_id: PassthroughPartyId,
maximum_bit_rate: u32,
},
ControlMultimediaTransmission {
call_id: CallId,
passthrough_party_id: PassthroughPartyId,
control: MultimediaTransmitControl,
},
OpenOutboundMedia {
call_id: CallId,
source: Option<MediaEndpoint>,
endpoint: MediaEndpoint,
codec: Codec,
packet_ms: u32,
max_frames_per_packet: u32,
dtmf_mode: DtmfMode,
audio_processing: AudioProcessingPolicy,
traffic_class: MediaTrafficClass,
},
CloseReceiveChannel {
call_id: CallId,
},
StartMedia {
call_id: CallId,
endpoint: MediaEndpoint,
dtmf_mode: DtmfMode,
audio_processing: AudioProcessingPolicy,
traffic_class: MediaTrafficClass,
},
StartMulticastReception {
conference_id: ConferenceId,
call_id: CallId,
route: MulticastMediaRoute,
echo_cancellation: EchoCancellation,
g723_bitrate: G723BitRate,
},
StopMulticastReception {
conference_id: ConferenceId,
call_id: CallId,
},
StartMulticastTransmission {
conference_id: ConferenceId,
call_id: CallId,
route: MulticastMediaRoute,
precedence: u32,
silence_suppression: SilenceSuppression,
max_frames_per_packet: u32,
g723_bitrate: G723BitRate,
},
StopMulticastTransmission {
conference_id: ConferenceId,
call_id: CallId,
},
StopMedia {
call_id: CallId,
},
CloseCall {
call_id: CallId,
},
DisconnectDevice {},
}Expand description
Operation applied to the target station session in command-queue order.
Call-scoped actions resolve the server-owned CallId to the current wire
reference inside the session. Actions for stale calls are ignored, except
that Self::CloseCall also records an early cancellation so it can retire
an incoming offer that has not reached the session yet.
Outbound presentation normally progresses from Self::BeginCall through
proceeding or ringing to Self::CommitOutboundCall. Media actions allocate
a fresh request identity for each generation; close and stop actions retire
that identity so a late acknowledgement cannot settle replacement media.
Variants§
BeginCall
Create local station state and off-hook presentation for an outbound call whose adapter-side identity is already allocated.
BeginTransfer
Put a held source call into transfer mode and create its consultation call as the active off-hook presentation.
Fields
consultation_line_instance: LineInstanceSetCallInfo
CommitOutboundCall
PresentOutboundProceeding
PresentOutboundRinging
SetCallState
SetCallSelected
DisplayPrompt
ClearPrompt
SetStatusMessage
SetMicrophoneMode
SetRecordingStatus
ResetDevice
SetMwi
SetForwardStatus
Replace all three forwarding destinations displayed for a line.
None clears that forwarding kind; the server retains the complete
triple for subsequent station queries.
Fields
line_instance: LineInstanceSetFeatureStatus
SetDoNotDisturbStatus
SetMobilityAppearance
Install or remove the temporary line appearance owned by a mobility button, rebuilding the station button template atomically.
SetBlfStatus
ShowParkingMenu
ShowConferenceList
ShowConferenceParticipantActions
ShowTextService
Fields
line_instance: LineInstancecall_reference: CallReferencetransaction_id: TransactionIdpriority: PhoneServicePrioritydocument: CiscoIpPhoneTextShowInputService
Send an input-service form whose response is emitted as
DeviceEventKind::PhoneServiceResponse.
Fields
line_instance: LineInstancecall_reference: CallReferenceapplication_id: ApplicationIdtransaction_id: TransactionIdpriority: PhoneServicePrioritydocument: CiscoIpPhoneInputExecutePhoneActions
Fields
line_instance: LineInstancecall_reference: CallReferenceapplication_id: ApplicationIdtransaction_id: TransactionIdpriority: PhoneServicePrioritydocument: CiscoIpPhoneExecuteShowImageService
Fields
line_instance: LineInstancecall_reference: CallReferenceapplication_id: ApplicationIdtransaction_id: TransactionIdpriority: PhoneServicePrioritydocument: PhoneImageDocumentShowStatusService
Fields
line_instance: LineInstancecall_reference: CallReferenceapplication_id: ApplicationIdtransaction_id: TransactionIdpriority: PhoneServicePrioritydocument: PhoneStatusDocumentSetBackgroundImage
PreviewBackgroundImage
SetRingtone
StartTone
StartAnnouncement
Start one or more conference announcements with an explicit participant hearing mask and playback mode.
Fields
conference_id: ConferenceIdannouncements: Vec<AnnouncementEntry>participant_ids: Vec<ParticipantId>StopAnnouncement
Fields
conference_id: ConferenceIdAnnouncementFinish
StartRinging
StopRinging
OpenReceiveChannel
Ask the station to allocate its receive channel and begin a correlated media transaction.
Fields
source: Option<MediaEndpoint>Optional RTP source restriction. None accepts media from any
source and is encoded as the SCCP wildcard endpoint 0.0.0.0:0.
audio_processing: AudioProcessingPolicyOpenMultimediaReceiveChannel
Requires a connected call and an exact advertised receive capability; replacing a live generation writes its close first.
CloseMultimediaReceiveChannel
StartMultimediaTransmission
Requires a connected call and an exact advertised transmit capability; replacing a live generation writes its stop first.
StopMultimediaTransmission
SetMultimediaTransmitBitRate
Limits the exact live station video encoder identified by its current passthrough token.
NotifyMultimediaTransmitBitRate
Reports a bit-rate change for the exact live station video encoder.
ControlMultimediaTransmission
Applies typed feedback to the exact live station video encoder.
OpenOutboundMedia
Open both directions of an outbound media path in one session-writer transaction. The two SCCP frames are written ORC then SMT without a command-queue or acknowledgement boundary between them.
Fields
source: Option<MediaEndpoint>endpoint: MediaEndpointaudio_processing: AudioProcessingPolicytraffic_class: MediaTrafficClassCloseReceiveChannel
Close the station receive leg and retire its pending acknowledgement.
StartMedia
Fields
endpoint: MediaEndpointaudio_processing: AudioProcessingPolicytraffic_class: MediaTrafficClassStartMulticastReception
Fields
conference_id: ConferenceIdroute: MulticastMediaRouteecho_cancellation: EchoCancellationg723_bitrate: G723BitRateStopMulticastReception
StartMulticastTransmission
Fields
conference_id: ConferenceIdroute: MulticastMediaRoutesilence_suppression: SilenceSuppressiong723_bitrate: G723BitRateStopMulticastTransmission
StopMedia
Stop the station transmit leg and retire its pending acknowledgement.
CloseCall
Tear down station media and presentation, request final statistics when applicable, and retire the call identity.
DisconnectDevice
Trait Implementations§
Source§impl Clone for CommandAction
impl Clone for CommandAction
Source§fn clone(&self) -> CommandAction
fn clone(&self) -> CommandAction
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more