H5Player
FAQ
FAQ

Monitor access

1. API interface

1.1. createListener

describe

Create a listening instance

Example

  • listenPlayer = playerjs.createListener(options: Object)

parameter

Field Type Description Default value Is it required
devId string Device unique identifier Yes
channel string channel number yes
mediaProtocol string Media protocol: WS WS No
expireTime Number Address expiration time in seconds 20 No
optId String Business operation id, which can be used to operate trace records, etc. No
addrType number Address type: 1: External network address; 2: Intranet address; 1 No

1.2. Method

1.2.1. start

describe

Start listening

Example

  • listenPlayer.start()

1.2.2. stop

describe

Turn off listening

Example

  • listenPlayer.stop()

1.2.3. getStartTime

describe

Get the start time of monitoring and return the client UTC timestamp in ms.

Example

  • listenPlayer.getStartTime()

Note: If you want to get the end time, please refer to afterDestory in HOOKS

1.2.4. getDuration

describe

Get the listening time, in ms.

Example

  • listenPlayer.getDuration()

1.3. Properties

1.3.1. volume: number

describe

Set client playback volume

Example

  • listenPlayer.volume = 0.5

Set value range: Number, expected channel volume, range 0 - 1

2. Interface example

<script src="./streamax-player.js"></script>
<script>
     const StPlayer = H5Player;
     StPlayer.config = {
         httpProtocol: 'http',
         ip: '192.168.132.72',
         port: 21250,
     };
     StPlayer.defaultHeaders = {
         _appId: '1',
         _tenantId: '2',
     }
     let listenPlayer = null;
     // Turn on listening
     function openListener() {
         if (listenPlayer) {
             alert('Please close the current listening first');
             return;
         };
         const listenPlayer = StPlayer.createListener({
             devId: '03d430b6365943f1b02bdde73aceddf8',
             channel: 1
         });
         listenPlayer.hooks.afterLoaded.tap('play', () => {
             listenPlayer.start();
         });
         listenPlayer.hooks.afterListenTalkAutoClose.tap('auto close', () => {
             console.log('auto close');
         });
     }
     //Close listening
     function closeListener() {
         if (listenPlayer) {
             listenPlayer.stop();
             listenPlayer = null;
         }
     }
</script>
ON THIS PAGE