Viewing Components

We provide three base StreamViewer implementations that you can choose from depending on your case. Using them is a bit different but they all share the same functionality from the StreamViewer interface.

### StreamViewerController

A StreamViewerController is the low level implementation that, unlike the others, is detached from the UI. You will typically hold the controller instance in a ViewModel. Optionally, for perfect state restoration during configuration changes, we also recommend that you use Android's SavedStateHandle and pass it to the controller constructor.

class StreamingViewModel(state: SavedStateHandle) : ViewModel() {

    val streamViewer = StreamViewerController(state)

    override fun onCleared() {
        super.onCleared()
        streamViewer.release()
    }
}

As you can see, the StreamViewerController must be released when you're done with it. In order to show the UI and start using the host, you must also call one of the bind methods as soon as you have a view container. For example, with a fragment:

class StreamingFragment : Fragment() {
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        viewModel.streamViewer.bind(this, view.findViewById(R.id.streaming_container))
    }
}

By passing in the fragment instance, the controller will know how to ask for permissions. We also use the fragment lifecycle to avoid memory leaks, so there's no need to unbind.

StreamViewerFragment

The StreamViewerFragment is a fragment implemented exactly as described above. It is the recommended implementation as it is very easy to use - no need to release or bind UI, because the fragment owns the views.

You can customize the fragment after it is attached or when creating it, thanks to the StreamViewerOptions class:

val options = StreamViewerOptions.build {
    overlay(R.layout.custom_controls)
    aspectMode(AspectMode.CENTER_INSIDE)
    mute(false)
}
val fragment = StreamViewerFragment.newInstance(options)

StreamViewerView

The StreamViewerView is a view that holds a controller, to be used for codebases that do not use fragments at all. Just like the controller, you must pass a fragment / activity / lifecycle with bind() to use it. For example:

class StreamingActivity : AppCompatActivity() {

    val streamViewer by lazy { findViewById<StreamViewerView>(R.id.stream_viewer) }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.stream_activity)
        streamViewer.bind(this) // necessary!
    }
}