Skip to content

Jira/ms 16519 #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LichKing-2234 merged 11 commits into from
Sep 4, 2020
Merged

Jira/ms 16519 #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1fa6c2d
Update documentation comments
TingChen2020 Aug 16, 2020
17eb36f
Merge branch 'master' into jira/MS-16519
TingChen2020 Aug 16, 2020
f80d9e1
Merge branch 'rc/3.0.1' into jira/MS-16519
TingChen2020 Aug 18, 2020
f6c3e60
Udate documentation comments
TingChen2020 Aug 19, 2020
fab89ad
Merge branch 'rc/3.0.1' into jira/MS-16519
TingChen2020 Aug 25, 2020
7433808
documentation update
TingChen2020 Aug 27, 2020
61e4855
documentation update
TingChen2020 Aug 31, 2020
542f3ce
update documentation
TingChen2020 Sep 4, 2020
e575fde
Update based on review comments
TingChen2020 Sep 4, 2020
77c475a
Replace @note
TingChen2020 Sep 4, 2020
9159ba1
remove @enum
TingChen2020 Sep 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
"jest": "^24.9.0",
"metro-react-native-babel-preset": "^0.56.0",
"react-test-renderer": "16.9.0",
"typescript": "^3.7.3"
"typedoc-plugin-no-inherit": "^1.1.10",
"typescript": "^4.0.2"
},
"jest": {
"preset": "react-native",
Expand Down
19 changes: 14 additions & 5 deletions src/RtcLocalView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ import {Platform, ViewProps} from "react-native";
import {RtcSurfaceView, RtcSurfaceViewProps, RtcTextureView, RtcTextureViewProps} from "./src/RtcRenderView.native";

/**
* Use SurfaceView in Android.
* Use UIView in iOS.
* The SurfaceView class.
*
* **Note**
*
* SurfaceView is supported on Android only. Use UIView on iOS.
*
* @noInheritDoc
*/
class SurfaceView extends Component<ViewProps & RtcSurfaceViewProps, {}> {
render() {
Expand All @@ -18,8 +23,12 @@ class SurfaceView extends Component<ViewProps & RtcSurfaceViewProps, {}> {
}

/**
* Use TextureView in Android.
* Not support for iOS.
* The TextureView class.
*
* **Note**
*
* TextureView is supported on Android only. iOS does not support TextureView.
* @noInheritDoc
*/
class TextureView extends Component<ViewProps & RtcTextureViewProps, {}> {
render() {
Expand All @@ -34,7 +43,7 @@ class TextureView extends Component<ViewProps & RtcTextureViewProps, {}> {
}

/**
* View for preview local video.
* View for previewing local video.
*/
export default {
SurfaceView,
Expand Down
19 changes: 14 additions & 5 deletions src/RtcRemoteView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ import {
} from "./src/RtcRenderView.native";

/**
* Use SurfaceView in Android.
* Use UIView in iOS.
* The SurfaceView class.
*
* **Note**
*
* SurfaceView is supported on Android only. Use UIView on iOS.
*
* @noInheritDoc
*/
class SurfaceView extends Component<ViewProps & RtcSurfaceViewProps & RtcUidProps, {}> {
render() {
Expand All @@ -22,8 +27,12 @@ class SurfaceView extends Component<ViewProps & RtcSurfaceViewProps & RtcUidProp
}

/**
* Use TextureView in Android.
* Not support for iOS.
* The TextureView class.
*
* **Note**
*
* TextureView is supported on Android only. iOS does not support TextureView.
* @noInheritDoc
*/
class TextureView extends Component<ViewProps & RtcTextureViewProps & RtcUidProps, {}> {
render() {
Expand All @@ -36,7 +45,7 @@ class TextureView extends Component<ViewProps & RtcTextureViewProps & RtcUidProp
}

/**
* View for render remote video.
* View for rendering remote video.
*/
export default {
SurfaceView,
Expand Down
Loading