id | title | hide_title | slug | displayed_sidebar | sidebar_position | image |
---|---|---|---|---|---|---|
docs-video-develop-request-video-call |
Request Video Call |
true |
./request-video-call |
pushVideoSidebar |
6 |
/assets/docs/previews/docs_video_develop--request_video_call.png |
This section covers everything you need to do to request video calls.
<title>Request Video Call | Push Video | Push Documentation</title>When a user requests a video call, the stream emits CONSTANTS.VIDEO.EVENT.REQUEST
event on the receiver's end which can be used to display a modal to accept/deny the call.
// aliceVideoCall.request(recipients[], options?);
await aliceVideoCall.request([recipient]);
Property | Type | Sub Type | Description |
---|---|---|---|
recipients |
string[] |
- | Wallet address or addresses of the recipient(s). Number of different wallet standards are suppported. |
options? |
VideoInitializeOptions |
- | - |
options.rules.access.type |
string |
Identifier for Push Video or Space. We use VIDEO_NOTIFICATION_ACCESS_TYPE.PUSH_CHAT from @pushprotocol/restapi here for Push Video |
|
options.rules.access.data.chatId? |
string |
Unique identifier for every push chat, here, the one between the alice and the bob |
Note: Parameters
in this style
are mandatory.
200 OK