Loading...
Loading...
Compare original and translation side by side
PREREQUISITES:
— Project must have server-side capability (API key must never be exposed to the client)+rw-check-compatibility — Load the latest API reference from https://docs.dev.runwayml.com/api/ before integrating+rw-fetch-api-reference — Character (Avatar) must be created and session endpoint must exist+rw-integrate-characters- Project must use React (Next.js, Vite+React, Remix, etc.)
OPTIONAL:
— Add knowledge base before embedding+rw-integrate-documents
@runwayml/avatars-react前提条件:
— 项目必须具备服务器端能力(API密钥绝不能暴露给客户端)+rw-check-compatibility — 集成前请从https://docs.dev.runwayml.com/api/加载最新的API参考文档+rw-fetch-api-reference — 必须已创建角色(头像)且会话端点已存在+rw-integrate-characters- 项目必须使用React(Next.js、Vite+React、Remix等)
可选操作:
— 嵌入前添加知识库+rw-integrate-documents
@runwayml/avatars-reactnpm install @runwayml/avatars-react@runwayml/sdk+rw-integrate-charactersnpm install @runwayml/avatars-react@runwayml/sdk+rw-integrate-charactersAvatarCallAvatarCall'use client';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
export default function CharacterPage() {
return (
<AvatarCall
avatarId="your-avatar-id-here"
connectUrl="/api/avatar/session"
onEnd={() => console.log('Call ended')}
onError={(error) => console.error('Error:', error)}
/>
);
}'use client';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
export default function CharacterPage() {
return (
<AvatarCall
avatarId="your-avatar-id-here"
connectUrl="/api/avatar/session"
onEnd={() => console.log('Call ended')}
onError={(error) => console.error('Error:', error)}
/>
);
}AvatarCallAvatarCall| Prop | Type | Description |
|---|---|---|
| | The Avatar UUID from the Developer Portal or API |
| | Your server-side session endpoint (e.g., |
| | Called when the call ends normally |
| | Called on connection or runtime errors |
avatarId| 属性 | 类型 | 描述 |
|---|---|---|
| | 来自开发者门户或API的头像UUID |
| | 你的服务器端会话端点(例如: |
| | 通话正常结束时调用 |
| | 连接或运行时出错时调用 |
avatarIdAvatarSessionAvatarSession| Export | Type | Description |
|---|---|---|
| Component | Provider that manages the WebRTC session |
| Component | Renders the avatar's video stream |
| Component | Renders the user's camera feed |
| Hook | Access session state: |
| Hook | Control user's media: |
| 导出项 | 类型 | 描述 |
|---|---|---|
| 组件 | 管理WebRTC会话的提供者 |
| 组件 | 渲染头像的视频流 |
| 组件 | 渲染用户的摄像头画面 |
| Hook | 访问会话状态: |
| Hook | 控制用户媒体: |
'use client';
import {
AvatarSession,
AvatarVideo,
UserVideo,
useAvatarSession,
useLocalMedia,
} from '@runwayml/avatars-react';
import type { SessionCredentials } from '@runwayml/avatars-react';
function CallUI() {
const { state, end } = useAvatarSession();
const { isMicEnabled, toggleMic } = useLocalMedia();
return (
<div className="relative w-full h-screen">
{/* Avatar video takes full screen */}
<AvatarVideo className="w-full h-full object-cover" />
{/* User's camera in a small overlay */}
<UserVideo className="absolute bottom-4 right-4 w-48 rounded-lg" />
{/* Controls */}
<div className="absolute bottom-4 left-4 flex gap-2">
<button onClick={toggleMic}>
{isMicEnabled ? 'Mute' : 'Unmute'}
</button>
<button onClick={end}>End Call</button>
</div>
{/* Connection state */}
{state === 'connecting' && (
<div className="absolute inset-0 flex items-center justify-center bg-black/50">
Connecting...
</div>
)}
</div>
);
}
export function CustomAvatar({ credentials }: { credentials: SessionCredentials }) {
return (
<AvatarSession credentials={credentials} audio video>
<CallUI />
</AvatarSession>
);
}'use client';
import {
AvatarSession,
AvatarVideo,
UserVideo,
useAvatarSession,
useLocalMedia,
} from '@runwayml/avatars-react';
import type { SessionCredentials } from '@runwayml/avatars-react';
function CallUI() {
const { state, end } = useAvatarSession();
const { isMicEnabled, toggleMic } = useLocalMedia();
return (
<div className="relative w-full h-screen">
{/* 头像视频占满全屏 */}
<AvatarVideo className="w-full h-full object-cover" />
{/* 用户摄像头画面以小窗口叠加显示 */}
<UserVideo className="absolute bottom-4 right-4 w-48 rounded-lg" />
{/* 控制按钮 */}
<div className="absolute bottom-4 left-4 flex gap-2">
<button onClick={toggleMic}>
{isMicEnabled ? '静音' : '取消静音'}
</button>
<button onClick={end}>结束通话</button>
</div>
{/* 连接状态 */}
{state === 'connecting' && (
<div className="absolute inset-0 flex items-center justify-center bg-black/50">
连接中...
</div>
)}
</div>
);
}
export function CustomAvatar({ credentials }: { credentials: SessionCredentials }) {
return (
<AvatarSession credentials={credentials} audio video>
<CallUI />
</AvatarSession>
);
}AvatarSession'use client';
import { useState, useCallback } from 'react';
import type { SessionCredentials } from '@runwayml/avatars-react';
import { CustomAvatar } from './CustomAvatar';
export default function CharacterPage() {
const [credentials, setCredentials] = useState<SessionCredentials | null>(null);
const [loading, setLoading] = useState(false);
const startCall = useCallback(async () => {
setLoading(true);
try {
const res = await fetch('/api/avatar/session', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ avatarId: 'your-avatar-id-here' }),
});
const data = await res.json();
setCredentials(data);
} catch (error) {
console.error('Failed to connect:', error);
} finally {
setLoading(false);
}
}, []);
if (credentials) {
return <CustomAvatar credentials={credentials} />;
}
return (
<button onClick={startCall} disabled={loading}>
{loading ? 'Connecting...' : 'Start Conversation'}
</button>
);
}AvatarSession'use client';
import { useState, useCallback } from 'react';
import type { SessionCredentials } from '@runwayml/avatars-react';
import { CustomAvatar } from './CustomAvatar';
export default function CharacterPage() {
const [credentials, setCredentials] = useState<SessionCredentials | null>(null);
const [loading, setLoading] = useState(false);
const startCall = useCallback(async () => {
setLoading(true);
try {
const res = await fetch('/api/avatar/session', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ avatarId: 'your-avatar-id-here' }),
});
const data = await res.json();
setCredentials(data);
} catch (error) {
console.error('连接失败:', error);
} finally {
setLoading(false);
}
}, []);
if (credentials) {
return <CustomAvatar credentials={credentials} />;
}
return (
<button onClick={startCall} disabled={loading}>
{loading ? '连接中...' : '开始对话'}
</button>
);
}app/api/avatar/session/route.ts+rw-integrate-charactersapp/character/page.tsx'use client';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
const AVATAR_ID = process.env.NEXT_PUBLIC_AVATAR_ID || 'your-avatar-id';
export default function CharacterPage() {
return (
<div className="flex items-center justify-center min-h-screen">
<AvatarCall
avatarId={AVATAR_ID}
connectUrl="/api/avatar/session"
onEnd={() => window.location.reload()}
onError={(error) => {
console.error('Avatar error:', error);
alert('Connection failed. Please try again.');
}}
/>
</div>
);
}app/api/avatar/session/route.ts+rw-integrate-charactersapp/character/page.tsx'use client';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
const AVATAR_ID = process.env.NEXT_PUBLIC_AVATAR_ID || 'your-avatar-id';
export default function CharacterPage() {
return (
<div className="flex items-center justify-center min-h-screen">
<AvatarCall
avatarId={AVATAR_ID}
connectUrl="/api/avatar/session"
onEnd={() => window.location.reload()}
onError={(error) => {
console.error('头像错误:', error);
alert('连接失败,请重试。');
}}
/>
</div>
);
}'use client';
import { useState } from 'react';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
export default function SupportPage() {
const [showAvatar, setShowAvatar] = useState(false);
return (
<div>
<h1>Customer Support</h1>
{!showAvatar ? (
<button onClick={() => setShowAvatar(true)}>
Talk to an Agent
</button>
) : (
<AvatarCall
avatarId="support-agent-id"
connectUrl="/api/avatar/session"
onEnd={() => setShowAvatar(false)}
onError={(error) => {
console.error(error);
setShowAvatar(false);
}}
/>
)}
</div>
);
}'use client';
import { useState } from 'react';
import { AvatarCall } from '@runwayml/avatars-react';
import '@runwayml/avatars-react/styles.css';
export default function SupportPage() {
const [showAvatar, setShowAvatar] = useState(false);
return (
<div>
<h1>客户支持</h1>
{!showAvatar ? (
<button onClick={() => setShowAvatar(true)}>
与客服Agent对话
</button>
) : (
<AvatarCall
avatarId="support-agent-id"
connectUrl="/api/avatar/session"
onEnd={() => setShowAvatar(false)}
onError={(error) => {
console.error(error);
setShowAvatar(false);
}}
/>
)}
</div>
);
}<AvatarCall
avatarId="your-avatar-id"
connectUrl="/api/avatar/session"
onError={(error) => {
console.error('Avatar error:', error);
console.error('Error name:', error.name);
console.error('Error message:', error.message);
if (error.cause) {
console.error('Cause:', error.cause);
}
}}
/><AvatarCall
avatarId="your-avatar-id"
connectUrl="/api/avatar/session"
onError={(error) => {
console.error('头像错误:', error);
console.error('错误名称:', error.name);
console.error('错误信息:', error.message);
if (error.cause) {
console.error('原因:', error.cause);
}
}}
/>import { useAvatarSession } from '@runwayml/avatars-react';
function DebugPanel() {
const { state, sessionId, error } = useAvatarSession();
return (
<pre style={{ fontSize: 12, position: 'fixed', top: 0, right: 0 }}>
{JSON.stringify({ state, sessionId, error: error?.message }, null, 2)}
</pre>
);
}import { useAvatarSession } from '@runwayml/avatars-react';
function DebugPanel() {
const { state, sessionId, error } = useAvatarSession();
return (
<pre style={{ fontSize: 12, position: 'fixed', top: 0, right: 0 }}>
{JSON.stringify({ state, sessionId, error: error?.message }, null, 2)}
</pre>
);
}| Browser | Minimum Version |
|---|---|
| Chrome | 74+ |
| Firefox | 78+ |
| Safari | 14.1+ |
| Edge | 79+ |
| 浏览器 | 最低版本 |
|---|---|
| Chrome | 74+ |
| Firefox | 78+ |
| Safari | 14.1+ |
| Edge | 79+ |
import '@runwayml/avatars-react/styles.css'AvatarCall'use client'onEndAvatarCallimport '@runwayml/avatars-react/styles.css''use client'onEnd