nexxPLAY
Search…
React Plugin
The nexxPLAY Embed Code System works also in any React Project. You can simply embed any iFrame Plugin to embed a nexxPLAY instance directly.
For more Control, 3Q nexx offers a dedicated React Plugin, that can be added to your Project easily. It supports all Streamtypes and Widgets and all Post-Message controlled Functionality.
You can find the Project here:
3qnexx/nexxPLAY-React
GitHub
Basic Integration
1
npm install nexxplay-react
Copied!
A very simple Usage could look like this:
1
import React from 'react';
2
import {NexxPLAY} from "nexxplay-react";
3
​
4
class test extends React.Component{
5
​
6
render(){
7
return (
8
<div style={{width:"640px",height:"320px"}}>
9
<NexxPLAY domain="999" mediaHash="ABCDEFG" streamtype="video" params="{{autoPlay:0}}" />
10
</div>
11
);
12
}
13
​
14
}
Copied!
Supported Attributes
You can use the following Attributes directly in your JSX - only "domain" and "media" are mandatory, the rest is optional (if you need any other Streamtype than "video", "streamtype" is also mandatory").
Attribute
Type
Description
domain
int
your 3Q nexx Domain ID
mediaHash
String
the "Hash" of the Media, you want to include
streamtype
[video, audio, live, radio, playlist, audioalbum, collection, set, rack, widget]
the Streamtype of the given Media Hash. If omitted, defaults to "video".
deliveryPartner
String
if the Media Reporting should be connected to a Delivery Partner, add its Code here.
embedHost
String
if you use a custom Embed Domain, enter the Domain (without protocol and Slashes) here. It defaults to "embed.nexx.cloud".
protocol
String
if you want to force "http" Usage, set this to "http". It defaults to "https".
params
Object with the following possible Keys [autoPlay, language, dataMode, exitMode, streamingFilter, consentString, delay, disableAds, affiliateCode]
if you need additional Parameters, that would be appended via GET Parameters, set them here.
onPlayerEvent
function
to receive PlayerEvents in your app (see below)
onPlayerData
function
to receive Player Metadata in your app (see below)
​
Interacting with the Player
If you want to interact with the Player, there are two possible Scenarios.
If your App needs the Events, the Player emit, add a "onPlayerEvent" Function to the XJS. In this Case, every Event will be sent to this Function for Processing in your App.
Furthermore, there are various Calls, that will send you Information about the Player/Playbackstate. For this Purpose, add "onPlayerData" to the XJS.
1
import React from 'react';
2
import NexxPLAY from "nexxplay-react";
3
​
4
class test extends React.Component{
5
​
6
onPlayerEvent(event){
7
console.log(event);
8
}
9
10
onPlayerData(data){
11
console.log(data);
12
}
13
14
render(){
15
return (
16
<div style={{width:"640px",height:"320px"}}>
17
<NexxPLAY domain="999" media="ABCDEFG" streamtype="video"
18
onPlayerEvent={this.onPlayerEvent}
19
onPlayerData={this.onPlayerData}
20
/>
21
</div>
22
);
23
}
24
​
25
}
Copied!
Available Functions
You can control each Player Instance after it has been created with the general SDK Functions from within React by creating a Reference to the Instance and use its Methods afterwards.
1
import React from 'react';
2
import NexxPLAY from "nexxplay-react";
3
​
4
class test extends React.Component{
5
​
6
constructor(props) {
7
super(props);
8
this.player = null;
9
}
10
​
11
pausePlayer(){
12
if(this.player!==null){
13
this.player.pause();
14
}
15
}
16
17
seekToPosition(position){
18
if(this.player!==null){
19
this.player.seekTo(position);
20
}
21
}
22
23
render(){
24
return (
25
<div style={{width:"640px",height:"320px"}}>
26
<NexxPLAY domain="999" media="ABCDEFG" streamtype="video"
27
onRef={(ref) => (this.player = ref)}
28
/>
29
</div>
30
);
31
}
32
​
33
}
Copied!
You can use the all Functions, that are given in the SDK OVerview here:
Available Events
If you decide to listen for the Player Events, you will receive all Events, that are given here:
The React Plugin for nexxPLAY also supports Widgets.
Last modified 2mo ago