RealtimeAPI extension
- on
Methods
-
acceptCall(
{required String callId, String sessionType = 'realtime', RealtimeModel? model, String? instructions, List< Modality> ? outputModalities, RealtimeSessionAudio? audio, List<RealtimeFunctionTool> ? tools, ToolChoice? toolChoice, dynamic maxOutputTokens, List<String> ? include, Tracing? tracing, Map<String, dynamic> ? prompt, dynamic truncation}) → Future<void> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Accept an incoming SIP call and configure the realtime session that will handle it. -
createCall(
{required String sdp, RealtimeSessionType type = RealtimeSessionType.realtime, RealtimeModel? model, String? instructions, dynamic maxOutputTokens, List< Modality> ? outputModalities, RealtimeSessionAudio? audio, List<RealtimeFunctionTool> ? tools, ToolChoice? toolChoice, Tracing? tracing, List<String> ? include, Map<String, dynamic> ? prompt, RealtimeTruncation? truncation, double? temperature}) → Future<CreateRealtimeCallResponse> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Create a new Realtime API call over WebRTC and receive the SDP answer. -
createRealtimeClientSecret(
{int? expiresAfterSeconds, String expiresAfterAnchor = 'created_at', Map< String, dynamic> ? sessionJson, String sessionType = 'realtime', String? model, List<Modality> ? outputModalities, AudioFormat? inputAudioFormat, AudioFormat? outputAudioFormat, SpeechVoice? voice, num? speed, String? instructions, dynamic maxOutputTokens, List<RealtimeFunctionTool> ? tools, ToolChoice? toolChoice, Tracing? tracing, TurnDetection? turnDetection, NoiseReduction? inputAudioNoiseReduction, InputAudioTranscription? inputAudioTranscription, List<String> ? include}) → Future<CreateRealtimeClientSecretResponse> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Create an ephemeral client secret (ek_...) with an associated session config. -
hangupCall(
{required String callId}) → Future< void> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Hang up an active realtime call (SIP or WebRTC). -
referCall(
{required String callId, required String targetUri}) → Future< void> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Transfer an active SIP call to another destination (SIP REFER). -
rejectCall(
{required String callId, int? statusCode}) → Future< void> -
Available on OpenAIClient, provided by the RealtimeAPI extension
Reject an incoming call with an optional SIP status code. Default server behavior is 603 (Decline) if statusCode is omitted.