Skip to content

Commit aa8e909

Browse files
committed
fix: add description to demo pages to explain what is shown
1 parent 1f00547 commit aa8e909

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

apps/browser-example/src/pages/OfficialSDKWebSocketExample.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ export function OfficialSDKWebSocketExample({
7676
return (
7777
<div className="container">
7878
<h1>Official SDK WebSocket Example</h1>
79+
<p>
80+
This example demonstrates the Official OpenAI SDK's WebSocket client. It
81+
does not go to the trouble of decoding the audio streams and hooking
82+
them up to the browser. So you only see the data events. To experience
83+
the streaming audio with a back-and-forth conversation, see the WebRTC
84+
Example.
85+
</p>
7986
<RealtimeSessionView
8087
startSession={startSession}
8188
stopSession={stopSession}

apps/browser-example/src/pages/WebRTCExample.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ export function WebRTCExample({
4242
return (
4343
<div className="container">
4444
<h1>WebRTC Example</h1>
45+
<p>
46+
This example demonstrates how to use the OpenAI Realtime API directly.
47+
It is using the TypeScript client from the article
48+
https://scott.willeke.com/ai-typescript-client-for-openai-realtime-api .
49+
</p>
4550
<audio ref={audioElementRef}></audio>
4651
<RealtimeSessionView
4752
startSession={startSession}

0 commit comments

Comments
 (0)