Logo
Getting Started
Overview

Getting Started

Run ION locally using TCP or stdio and verify a basic stream.

1 min read
Install TCP stdio

Prerequisites

  • Go installed and available in your PATH
  • Local checkout of the ion repository

Quick Start (TCP)

Start the demo server:

Terminal window
go run ./cmd/demo-server --transport=tcp --addr :10300

In another terminal, run the CLI client:

Terminal window
go run examples/cli/ion-client.go --transport=tcp --addr :10300 --duration 3s --out out.pcm

out.pcm is raw PCM (16000Hz, mono, s16le).

Quick Start (stdio)

Use two FIFOs for full duplex:

Terminal window
mkfifo c2s s2c


go run ./cmd/demo-server --transport=stdio < c2s > s2c &
SERVER_PID=$!


go run examples/cli/ion-client.go --transport=stdio < s2c > c2s


kill $SERVER_PID
rm -f c2s s2c

Verify Expected Flow

  • Client sends describe
  • Server responds ready
  • Client sends start
  • Audio frames are exchanged
  • Client sends stop