asterisk-ari-client-rs 0.1.3

Simple Asterisk ARI library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use crate::errors::Result;
use crate::models::playbacks::Playback;
use async_trait::async_trait;

#[async_trait]
pub trait ChannelsAPI {
    /// Answer a channel.
    async fn answer(&self, channel_id: &str) -> Result<()>;
    /// Play media to a channel
    async fn play(
        &self,
        channel_id: &str,
        media: &str,
        _playback_id: Option<String>,
        _lang: Option<String>,
        _offsetms: Option<usize>,
        _skipms: Option<usize>,
    ) -> Result<Playback>;
    /// Stop playing particular playback
    async fn stop_play(&self, playback_id: &str) -> Result<()>;

    /// Get the value of a channel variable
    async fn get_variable(&self, channel_id: &str, var_name: &str) -> Result<String>;

    /// Set the value of a channel variable
    async fn set_variable(&self, channel_id: &str, var_name: &str, var_value: &str) -> Result<()>;

    /// Hang up the channel
    async fn hangup(&self, channel_id: &str) -> Result<()>;

    /// Exit application; continue execution in the dialplan
    async fn continue_in_dialplan(&self, channel_id: &str) -> Result<()>;

    /// Record audio from a channel. Default filepath: /var/spool/asterisk/recording/channel_id.wav
    #[allow(clippy::too_many_arguments)]
    async fn record(
        &self,
        channel_id: &str,
        filepath: Option<&str>,
        audio_format: Option<&str>,
        terminate_on: Option<&str>,
        max_duration: Option<usize>,
        max_silence: Option<usize>,
        if_exists: Option<&str>,
        beep: Option<bool>,
    ) -> Result<()>;
}