NwPlayer Interface

welcome to the nwplayer interface documentation! this is the prime interface for integrating your custom external player with our sdk whether using exoplayer, another media player, or a custom built player, the nwplayer interface acts as a wrapper, allowing our sdk to recognize and interact with your player this interface is your gateway to controlling playback, managing player states, and ensuring seamless integration with the sdk in this guide, we will walk you through the key properties and functions of the nwplayer interface, along with examples and best practices to help you implement it effectively why nwplayer is critical the nwplayer interface is the backbone of your external player integration it defines how the sdk interacts with your player, from playback control to lifecycle management by implementing this interface, you ensure your player works seamlessly with the sdk, providing a consistent user experience key properties and functions below, we will break down the most important properties and functions of the nwplayer interface, along with examples and use cases bitrate long purpose represents the current bitrate of the media stream why it is important during camera switching or quality changes, the bitrate ensures that the player adapts to the new stream without compromising quality what it does this example code initializes a bandwidthmeter with 50% of the initial bitrate, ensuring smooth transitions during camera switches private val bandwidthmeter by lazy { val initbitrate = (bitrate 0 5) tolong() // use 50% of the initial bitrate timber tag("estimatedbandwidth") d("exoplayer bandwidthmeter $initbitrate || initialbitrateestimate $bitrate") defaultbandwidthmeter builder(context) setinitialbitrateestimate(initbitrate) build() apply { addeventlistener(mainhandler, this\@externalnwplayer) } } disableaudio boolean and disablevideo boolean purpose these properties turn off audio or video playback during a global audio based event why it’s important in a global audio event, the sdk initializes two independent players one is for audio only playback (no video rendering is needed) one is for video playback (no audio is needed) to optimize performance and resource usage for the audio only player , video rendering should be disabled (disablevideo = true) for the video player , audio should be disabled (disableaudio = true) this ensures that each player only handles the necessary components, reducing unnecessary resource consumption disabling audio when disableaudio is true , the player’s audio track is disabled, and the volume is set to 0 (optional) override var disableaudio boolean = false set(value) { volume = if (value) 0 0f else 1 0f // mute the player if audio is disabled field = value } disabling video when disablevideo is true , the player’s video track is disabled, and no video is rendered fun generateexoplayerbuilder( ) exoplayer { val trackselector = defaulttrackselector(context, videotrackselectionfactory) val parametersbuilder = defaulttrackselector parameters builder(context) // disable audio or video tracks based on the properties when { disableaudio > { parametersbuilder setrendererdisabled(c track type audio, true) // disable audio track } disablevideo > { parametersbuilder setrendererdisabled(c track type video, true) // disable video track } } trackselector setparameters(parametersbuilder build()) // initialize exoplayer with the configured track selector return exoplayer builder(context) setbandwidthmeter(bandwidthmeter) settrackselector(trackselector) setloadcontrol(loadcontrol) setliveplaybackspeedcontrol(liveplaybackspeedcontrol) build() } what it does the trackselector is configured to disable either the audio or video renderer based on the values of disableaudio and disablevideo this ensures that the player only processes the required tracks, improving efficiency onpause() and onresume() purpose these functions handle the player’s lifecycle when the app goes to the background or comes to the foreground why it’s important properly managing the player’s lifecycle ensures efficient resource usage and a smooth user experience what it does this example code onresume prepares the player for playback when the app comes to the foreground onpause stops the player to prevent unnecessary resource usage when the app goes to the background override fun onresume() { timber tag(log tag) d("onresume") exoplayer prepare() // prepare the player when the app resumes } override fun onpause() { timber tag(log tag) d("onpause") stop() // stop the player when the app goes to the background } nwplayer interface functions and properties here is a complete list of the nwplayer interface’s functions and properties, along with their responsibilities playbackobject playbackobject represents the media content to be played, including metadata, urls, and drm configurations playerlistener nwplayerlistener nwplayerlistener a listener that communicates player events (e g , buffering, errors, state changes) to the sdk please read " nwplayerlistener interface " and how to call and utilize the functions of nwplayerlistener in detail nwplayerview nwplayerview? provides the player's ui view for rendering video content please read " nwplayer view " on how to set nwplayerview in detail bitrate long represents the current bitrate of the media stream speed float controls the playback speed of the media volume float controls the audio volume of the player disableaudio boolean disables audio of a video playback in a global audio event disablevideo boolean disables video of a audio playback in a global audio event duration long returns the total duration of the media in milliseconds position long returns the current playback position in milliseconds buffer long returns the current buffered position in milliseconds prepare() prepares the player for playback, including initializing the player and setting up the media source resume() resumes playback from the current position pause() pauses playback at the current position seekto(offsetms long) seeks to a specific position, offsetms in the media (in milliseconds) stop() stops playback and releases resources associated with the player release() releases all resources held by the player onresume() called when the player should resume playback after being paused (e g when the app comes to the foreground) onpause() called when the player should pause playback (e g when the app goes to the background) key takeaways here is what you need to remember when implementing the nwplayer interface bitrate management use the bitrate property to ensure smooth transitions during camera switches or quality changes global audio events use disableaudio and disablevideo to optimize player performance during global audio events muting audio when disableaudio is true, set the volume to 0 to mute the player disabling tracks use defaulttrackselector to disable unnecessary tracks (audio or video) during player initialization resource efficiency disabling unused tracks reduces resource consumption and improves performance lifecycle management implement onresume() and onpause() to manage the player’s lifecycle efficiently player events use the playerlistener to communicate player events to the sdk ui integration provide a custom player view using nwplayerview