@ getcobrowse/ react- native (英语)
反应原生SDK用于Cobrowse屏幕共享. 启用代理可以实时查看客户的移动屏幕,并带有说明,光标和亮点.
使用本地屏幕捕获(ReplayKit on iOS,MediaProjection on Android)通过Daily.js.
安装
# Install the SDK
npm install @getcobrowse/react-native
# Install peer dependencies
npm install @daily-co/react-native-daily-js @daily-co/react-native-webrtc react-native-svg
iOS 设置( Expo)
将配置插件添加到您的 app.json 或者说 app.config.js数字 :
{
"expo": {
"plugins": [
["@getcobrowse/react-native/plugin/withCobrowseBroadcast", {
"appGroup": "group.com.yourcompany.yourapp.cobrowse"
}]
]
}
}
然后重建:
npx expo prebuild --clean
npx expo run:ios --device
重要内容: 屏幕共享需要 真设备 ——在iOS模拟器中不起作用. 您也需要开发, 而不是 Expo Go .
iOS 设置( Bare React Introduction)
iOS 屏幕共享需要一个 广播上传扩展. Daily的SDK处理所有的IPC和帧编码——你只需要创建目标并把它接上.
1. 建立扩展目标:
Xcode: File → New → 目标 → 广播上传扩展. 说吧 CobrowseBroadcast。取消检查“插入 UI 扩展”.
2. 替换 SampleHandler.swift数字 :
替换生成 SampleHandler.swift 改为:
import ReactNativeDailyJSScreenShareExtension
public class SampleHandler: DailyRPHandler {
override init() {
super.init(appGroupIdentifier: "group.com.yourcompany.yourapp.cobrowse")
}
}
3. 配置 App 组:
Xcode 中,启用“ App Groups” 功能,用于 两者 您的主要应用目标 CobrowseBroadcast 扩展目标。 将相同的组标识符添加到两者中 .
4. 在Info.plist中添加:
在你的主要应用程序 Info.plist数字 :
<key>RTCAppGroupIdentifier</key>
<string>group.com.yourcompany.yourapp.cobrowse</string>
<key>DailyScreenCaptureExtensionBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER).CobrowseBroadcast</string>
5. 安装吊舱并重建:
cd ios && pod install && cd ..
重要内容: 屏幕共享需要 真设备 ——在iOS模拟器中不起作用.
Android 设置
添加为 AndroidManifest.xml数字 :
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
在您的列表中注册前景服务 :
<service
android:name="com.daily.reactlibrary.DailyOngoingMeetingService"
android:foregroundServiceType="mediaProjection" />
使用量
基本设置(2行)
包装您的应用程序 CobrowseProvider数字 :
import { CobrowseProvider } from '@getcobrowse/react-native'
export default function App() {
return (
<CobrowseProvider
serverUrl="https://cobrowse.owner.sh"
metadata={{ email: user.email, name: user.name }}
>
<YourApp />
</CobrowseProvider>
)
}
就是这样。 SDK会:
- Corowse 仪表板上的注册存在
- 当代理请求屏幕共享时显示模式
- 通过 ReplayKit/ MediaProjection 处理本地屏幕捕获
- 显示代理说明( 曲线、 突出显示、 指针) 为覆盖
跟踪当前屏幕
过 screenName 显示用户在仪表板上的屏幕:
<CobrowseProvider
serverUrl="https://cobrowse.owner.sh"
metadata={{ email: user.email }}
screenName={currentRouteName}
>
用钩子
访问浏览状态和任何组件的控制 :
import { useCobrowse } from '@getcobrowse/react-native'
function SupportButton() {
const { state, agentName, stop } = useCobrowse()
if (state === 'sharing') {
return (
<Button onPress={stop}>
Stop sharing with {agentName}
</Button>
)
}
return null
}
自动接收( 窗口模式)
跳过权限模式和自动接受共享请求 :
<CobrowseProvider
serverUrl="https://cobrowse.owner.sh"
metadata={{ deviceId: 'kiosk-001' }}
autoAccept
>
浮动共享指标
使用内置 SharingIndicator 组件 :
import { SharingIndicator } from '@getcobrowse/react-native'
function MyScreen() {
return (
<View>
{/* Your content */}
<View style={{ position: 'absolute', bottom: 40, alignSelf: 'center' }}>
<SharingIndicator />
</View>
</View>
)
}
自定义共享请求 UI
禁用内置模式并处理自己的请求 :
import { CobrowseProvider, useCobrowse } from '@getcobrowse/react-native'
function App() {
return (
<CobrowseProvider
serverUrl="https://cobrowse.owner.sh"
metadata={{ email: user.email }}
onShareRequest={(agentName) => {
// Custom notification, bottom sheet, etc.
}}
autoAccept={false}
>
<CustomShareUI />
</CobrowseProvider>
)
}
function CustomShareUI() {
const { state, agentName, acceptShare, declineShare } = useCobrowse()
if (state !== 'share_requested') return null
return (
<BottomSheet>
<Text>{agentName} wants to view your screen</Text>
<Button onPress={acceptShare}>Allow</Button>
<Button onPress={declineShare}>Decline</Button>
</BottomSheet>
)
}
回电
<CobrowseProvider
serverUrl="https://cobrowse.owner.sh"
metadata={{ email: user.email }}
onStateChange={(state) => analytics.track('cobrowse_state', { state })}
onShareRequest={(agentName) => console.log(`${agentName} wants to share`)}
onAnnotation={(event) => {
// event.type: 'cursor' | 'highlight' | 'pointer' | 'clear' | 'cursor-hide'
}}
>
API 参考
<CobrowseProvider>
| Prop | 类型 | 需求 | 说明 |
|---|---|---|---|
serverUrl | string | 对 | 浏览服务器 URL |
metadata | Record<string, unknown> | 没有 | 用户识别元数据 |
screenName | string | 没有 | 当前仪表板的屏幕名称 |
autoAccept | boolean | 没有 | 自动接受共享请求 |
onShareRequest | (agentName: string) => void | 没有 | 代理请求共享时调用 |
onStateChange | (state: CobrowseState) => void | 没有 | 调用国家过渡 |
onAnnotation | (event: AnnotationEvent) => void | 没有 | 收到说明后调用 |
useCobrowse()
回返a CobrowseHandle数字 :
| 财产 | 类型 | 说明 |
|---|---|---|
state | CobrowseState | 当前 SDK 状态 |
agentName | string | null | 请求/查看代理人姓名 |
acceptShare | () => void | 接受待决共享请求 |
declineShare | () => void | 拒绝待处理的共享请求 |
stop | () => Promise<void> | 停止活动屏幕共享 |
setMetadata | (metadata) => void | 更新用户元数据 |
setScreenName | (name) => void | 更新当前屏幕名称 |
annotations | Annotation[] | 当前突出显示说明 |
pointerAnimations | PointerAnimation[] | 当前指针波纹 |
cursor | CursorPosition | 代理光标位置 |
CobrowseState
'idle' | 'tracking' | 'share_requested' | 'connecting' | 'sharing' | 'stopping'