react-native-rtmp-publisher
โ ๏ธ
iOS on development
Installation
npm install react-native-rtmp-publisher
or
yarn add react-native-rtmp-publisher
Usage
Android
Add Android Permission for camera
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
iOS
Under development
React Native
import { RTMPPublisher } from 'react-native-rtmp-publisher';
// ...
function publisherActions() {
publisherRef.current.startStream();
publisherRef.current.stopStream();
publisherRef.current.mute();
publisherRef.current.unmute();
publisherRef.current.switchCamera();
publisherRef.current.getPublishURL();
publisherRef.current.isMuted();
publisherRef.current.isStreaming();
publisherRef.current.hasCongestion();
publisherRef.current.isAudioPrepared();
publisherRef.current.isVideoPrepared();
publisherRef.current.isCameraOnPreview();
}
<RTMPPublisher
ref={publisherRef}
publishUrl="rtmp://your-publish-url"
onLayoutChange={() => null}
onConnectionFailedRtmp={(d: string) => null}
onConnectionStartedRtmp={(d: string) => null}
onConnectionSuccessRtmp={() => null}
onDisconnectRtmp={() => null}
onNewBitrateRtmp={(d: number) => null}
onStreamStateChanged={(d: streamState) => null}
/>;
Props
| Name | Type | Required | Description |
|---|---|---|---|
publishUrl |
string |
true |
Publish URL address with RTM Protocol |
Events
| Name | Returns | Description |
|---|---|---|
onLayoutChange |
null |
Invokes on layout changes |
onConnectionFailed |
string |
Invokes on connection fails with reason to publish URL |
onConnectionStarted |
string |
Invokes on connection start to publish URL |
onConnectionSuccess |
null |
Invokes on connection success to publish URL |
onDisconnect |
null |
Invokes on disconnect from publish URL |
onNewBitrateReceived |
number |
Invokes with new bitrate value on when bitrate received from URL |
onStreamStateChanged |
streamState |
Invokes on stream state changes. It can be use alternatively for above connection events. |
Methods
| Name | Returns | Description |
|---|---|---|
startStream |
null |
Starts the stream |
stopStream |
null |
Stops the stream |
mute |
null |
Mutes the microphone |
unmute |
null |
Unmutes the microphone |
switchCamera |
null |
Switches the camera |
getPublishURL |
string |
Gets the publish URL |
isMuted |
boolean |
Returns microphone state |
isStreaming |
boolean |
Returns streaming state |
hasCongestion |
boolean |
Returns if congestion |
isAudioPrepared |
boolean |
Returns audio prepare state |
isVideoPrepared |
boolean |
Returns video prepare state |
isCameraOnPreview |
boolean |
Returns camera is on |
Types
| Name | Value |
|---|---|
streamState |
CONNECTING CONNECTED DISCONNECTED FAILED |
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
42 Dec 17, 2022
7 Dec 21, 2022
7 May 2, 2022
28 Dec 4, 2022
235 Dec 19, 2022
4 Jan 13, 2022
18 Jan 5, 2023
13 Dec 17, 2022
23 Sep 1, 2022
51 Sep 29, 2022