Skip to content

FreeClimbAPI/freeclimb-audio-stream-specification

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FreeClimb Audio Streaming

Summary

Audio Streaming is a mechanism to enable a direct connection from the FreeClimb platform to an application which will be responsible for directly processing and responding with audio packets. This differs significantly from the existing methods of interfacing with FreeClimb Calls, rather than sending PerCL commands or API requests you directly interact with streaming audio. This enables high performance applications that can perform real time transcription, speech synthesis, and other innovative solutions.

The gRPC stream uses Protobufs to communicate across the gRPC channel. The specification for the gRPC service and Protobuf messages is available here. This defines the bidirectional gRPC service used for communication between FreeClimb and the application.

Audio Streaming Structure

sequenceDiagram
actor c as Customer
participant s as Freeclimb Server
participant cw as Freeclimb Streaming Customer PerCL Endpoint
participant cl as Freeclimb Streaming Customer gRPC Endpoint
c ->> s: Establish SIP Phone Call
s ->> cw: Retrieve PerCL (AudioStream)
s ->> cl: Establish gRPC Channel (all communication happens over this channel)
c ->> s: Hangup
Loading

Detailed Documentation

Caveats (PLEASE READ)

Getting Started

PerCL

gRPC Server

Demo Application

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •