vamq 0.0.14

Consume audio chunk from Voice Activity Messaging via ZeroMQ.
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use serde_json::Value;

/// What you get back from `next_event()`
/// #[non_exhaustive] means you can add new variants later without breaking external matches.
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum RtEvent {
    /// PCM16 bytes from `response.output_audio.delta`
    AudioDelta(Vec<u8>), // response.output_audio.delta
    TextDelta(String), // response.output_text.delta

    /// Transcript of user (when enable_input_transcription=true)
    UserTranscriptDelta(String),
    UserTranscriptFinal(String),

    /// Transcript of assistant (when enable_output_audio_transcript=true)
    AssistantTranscriptDelta(String),

    /// A part of audio, text, transcription and others done
    PartDone(Value),

    /// The response is done (good place to rotate buffers/timestamps)
    ResponseDone(Value),

    /// response.completed
    Completed,
    SessionCreated(Value),
    /// OpenAI sent an error frame
    Error(String),
    /// Anything else you might want to log
    Other(Value),
    /// Underlying socket closed
    Closed,
    Idle,
}

#[derive(Debug, Clone, Copy)]
pub enum RealtimeProfile {
    S2S,
    TRANSCRIBE,
    TTS,
}

#[derive(Clone, Debug)]
pub struct RealtimeFeatures {
    pub profile: RealtimeProfile,

    pub enable_conversation: bool,

    pub enable_transcribe: bool,

    // transcript user's audio
    pub enable_input_transcription: bool,

    /// transcript output audio (for debug)
    pub enable_output_audio_transcript: bool,

    /// use server VAD or external VAD (if you have own VAD then set to -> false)
    pub use_server_vad: bool,
}

impl Default for RealtimeFeatures {
    fn default() -> Self {
        Self {
            profile: RealtimeProfile::S2S,
            enable_conversation: false,
            enable_transcribe: false,
            enable_input_transcription: false,
            enable_output_audio_transcript: false,
            use_server_vad: false,
        }
    }
}

impl RealtimeFeatures {
    pub fn from_profile(profile: RealtimeProfile) -> Self {
        match profile {
            RealtimeProfile::S2S => Self {
                profile,
                enable_conversation: true,
                enable_transcribe: false,
                enable_input_transcription: false,
                enable_output_audio_transcript: false,
                use_server_vad: false,
            },
            RealtimeProfile::TRANSCRIBE => Self {
                profile,
                enable_conversation: false,
                enable_transcribe: true,
                enable_input_transcription: true,
                enable_output_audio_transcript: false,
                use_server_vad: false,
            },
            RealtimeProfile::TTS => Self {
                profile,
                enable_conversation: true,
                enable_transcribe: false,
                enable_input_transcription: false,
                enable_output_audio_transcript: false,
                use_server_vad: false,
            },
        }
    }
}