Skip to content

Commit

Permalink
Merge pull request #1437 from AgoraIO/1423-macos-video-calling-sdk-qu…
Browse files Browse the repository at this point in the history
…ickstart-page-contains-mentionslinks-specific-to-ios

macOS 'Video Calling SDK quickstart' page contains mentions/links specific to iOS #1423
  • Loading branch information
billy-the-fish authored Jul 26, 2023
2 parents 83c849c + 84ece26 commit 35eecdf
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 13 deletions.
2 changes: 1 addition & 1 deletion shared/media-push/develop/_restful-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Details for these fields are shown in the following table:
| transcodeOptions.videoOptions.layout.RtcStreamView element | None | The video screen of each user on the canvas. See [RtcStreamView](../reference/restful-type-definition#layout) for details. |
| transcodeOptions.videoOptions.layout.ImageView element | None | The video image on the canvas, which can be used as a watermark. See [ImageView](../reference/restful-type-definition#layoutimageview) for details. |
|transcodeOptions.videoOptions.vertical | (Optional) JSON Object | Vertical layout. This parameter must be set when `layoutType` is 1. See [vertical](../reference/restful-type-definition#vertical) for details.|
| transcodeOptions.videoOptions.defaultPlaceholderImageUrl | (Required) String | The default user screen background image URL address. Supports images in JPG, PNG and GIF formats. This controls what happens when a user in a channel stops publishing their video stream:<li>If this field is set, the user's window switches to this background image.</li><li>If this field is not set, the user's window initially displays the last frame of the user's video. Once the layout refreshes, the window displays the background color of the canvas.</li> |
| transcodeOptions.videoOptions.defaultPlaceholderImageUrl | (Optional) String | The default user screen background image URL address. Supports images in JPG, PNG and GIF formats. This controls what happens when a user in a channel stops publishing their video stream:<li>If this field is set, the user's window switches to this background image.</li><li>If this field is not set, the user's window initially displays the last frame of the user's video. Once the layout refreshes, the window displays the background color of the canvas.</li> |
| transcodeOptions.videoOptions.bitrate | (Required) Number | The encoding bitrate (Kbps) of the video. The value range is [1,10000]. |
|transcodeOptions.videoOptions.gop|(Optional) Number|The GOP of the video. The defalt value is the value of `frameRate` * 2。|
| transcodeOptions.videoOptions.frameRate | (Optional) Number | The encoding frame rate (fps) of the video. The value range is [1,30]. The default value is 15. |
Expand Down
6 changes: 4 additions & 2 deletions shared/variables/platform.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ const data = {
NAME: 'iOS',
PATH: 'ios',
CLIENT: 'app',
PACKAGE_NAME: 'AgoraRtcEngine_iOS'
PACKAGE_NAME: 'AgoraRtcEngine_iOS',
PACKAGE_PRODUCT_NAME: 'RtcBasic'
},

'macos': {
NAME: 'macOS',
PATH: 'macos',
CLIENT: 'app',
PACKAGE_NAME: 'AgoraRtcEngine_macOS'
PACKAGE_NAME: 'AgoraRtcEngine_macOS',
PACKAGE_PRODUCT_NAME: 'RtcBasic'
},

'react-native': {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To create this UI, in `ViewController`, replace the contents of the file with th

### Handle the system logic

When your <Vpl k="CLIENT" /> launches, ensure that the permissions necessary to insert <Vpd k="PRODUCT" /> feature into the <Vpl k="CLIENT" /> are granted. If the permissions are not granted, use the built-in iOS feature to request them; if they are, return `true`.
When your <Vpl k="CLIENT" /> launches, ensure that the permissions necessary to insert <Vpd k="PRODUCT" /> feature into the <Vpl k="CLIENT" /> are granted. If the permissions are not granted, use the built-in <Vpl k="NAME" /> feature to request them; if they are, return `true`.

1. **Import <Vpd k="SDK" />**

Expand Down Expand Up @@ -170,9 +170,6 @@ To implement this logic, take the following steps:
<PlatformWrapper platform="ios">
<div class="note alert">You can enable both cameras using <Link to="{{Global.API_REF_IOS_ROOT}}/class_irtcengine.html#api_irtcengine_enablemulticamera">enableMultiCamera</Link>.</div>
</PlatformWrapper>
<PlatformWrapper platform="macos">
<div class="note alert">You can enable both cameras using <Link to="{{Global.API_REF_MACOS_ROOT}}/class_irtcengine.html#api_irtcengine_enablemulticamera">enableMultiCamera</Link>.</div>
</PlatformWrapper>

5. **Join and leave a channel**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
</PlatformWrapper>
You see the available <Vg k="COMPANY_NAME" /> packages. Add the **<Vpl k="PACKAGE_NAME"/>** package and any other functionality that you want to integrate into your app. For example, _AgoraAINoiseSuppressionExtension_. Choose a version later than 4.0.0.

1. Click **Add Package**. In the new window, click **Add Package**.
1. Click **Add Package**. In the new window, make sure to choose **<Vpl k="PACKAGE_PRODUCT_NAME" />** and click **Add Package**.

You see **AgoraRtcKit** in **Package Dependencies** for your project.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
<PlatformWrapper platform="macos">
- For a more complete example, see the [open source <Vpd k="PRODUCT"/> example project] on GitHub.

### API reference

- <Link to="{{Global.API_REF_MACOS_ROOT}}/class_irtcengine.html#api_irtcengine_enablemulticamera">enableMultiCamera</Link>
- For a more complete example, see the <Link to="{{GLOBAL.MACOS_API_EXAMPLES_ROOT}}"> open source <Vpd k="PRODUCT"/> example project</Link> on GitHub.

</PlatformWrapper>

0 comments on commit 35eecdf

Please sign in to comment.