View & Play Live Stream

Live streams and playback videos information are stored in AmityStream. This stream objects reside in AmityStreamRepository. To start working with stream, first the app need to intialize the repository.

// `client` is AmityClient that has been initiated during the setup 
streamRepository = AmityStreamRepository(client: client)

*Note : There is a limitation for the maximum concurrent live events. Please feel free to reach out to us at community.amity.co with your use-case and we will determine if the current limit can be raised.

Retrieve a stream object

Each stream object has a unique identifier. To retrieve a single stream object, call

• repository.getStreamById(_:)

This function returns a Live Object of AmityStream. The stream object contains essential data, for example, title and description.

let streamProxy = streamRepository.getStreamById(streamId)

getStreamToken = streamProxy.observe { (proxy, error) in
	// We have a stream object here.
	let stream = proxy.object
	print("Title: \(stream.title)")
	print("Description: \(stream.streamDescription)")
}

Stream Status

Stream consists of many states. It can change from one state to another, depending on events and actions.

AmityStreamStatus represents a stream status. The following enum cases describe all the possible status of a stream.

• .idle indicates "a stream that has generated but no actions have been taken."

• .live indicates "a stream is currently being broadcasted."

• .ended indicates "a stream has ended broadcasting and in the progress of transforming to a recorded stream."

• .recorded indicates "a stream has ended broadcasting and has been transformed to a recorded stream."

You can check the status of a stream by calling .status.

// Print out the current status of a stream.
print(stream.status)

Retrieve streams collection

To query streams collection, first you need to create a AmityStreamCollectionQuery.

// Create query object.
let query = AmityStreamCollectionQuery()
// Specify statuses to include in the streams collection.
query.includeStatus(.live)

Then call .getStreamsCollection(from:) with the query object that you've created.

• .getStreamsCollection(from: query)

This function returns the live collection of stream objects.

// Here we get AmityCollection<AmityStream>
streamsCollection = streamRepository.getStreamsCollection(from: query)

// An example of streams collection usage,
// to observe the changes and update UI.
token = streamsCollection.observe { [weak self] collection, change, error in
	// Any update will be notified here.
	self?.updateUI(from: collection)
}

If your app needs stream collections in many parts of the app. We recommend to maintain only one collection for each query, in an application scope. And use it as a single source of truth.

App.liveStreamsCollections = streamRepository.getStreamsCollection(from: liveStreamQuery)
App.liveStreamsToken = App.liveStreamsCollection.observe { collection, change, error in
	// Any update will be notified here.
	App.updateDataSource(from: collection)
	App.notifyLiveStreamsUpdate()
}

Play a live stream

if let urlInfo = stream.watcherUrl {

	// play with the full ur
	rtmpPlayer.play(urlInfo.url)

	// or for some players that require custom RTMP url formatting
	customRtmpPlayer.setHost("\(urlInfo.origin)/\(urlInfo.appName)?\(urlInfo.query)")
	customRtmpPlayer.play(urlInfo.streamName)

}

if (stream.isLive) {
	print("The stream is live now.")
}

Play recorded videos

Live streams are recorded, and saved as files after the session ends. It would take some time for preparing recorded videos to be ready. You can observe the collection of stream that has recorded videos available.

// Print out all mp4 url for all recorded videos of `stream`.
//
for (index, dataItem) in stream.recordingData.enumerated() {
	// Specify .MP4, to get the actual url in mp4 format.
	if let url = dataItem.url(for: .MP4) {
		print("Video \(index): \(url)")
	} else {
		print("Video \(index): url not found")
	}
}

Amity Video Player

Amity Video SDK includes AmityVideoPlayerKit.framework, a basic RTMP player to support live video functionality.

This framework requires MobileVLCKit.framework as a dependency. You can download the framework from the link provided in the Installation Steps.

Amity Recorded Stream Player

This player is the part of the Amity Video SDK, built as a subclass of AVPlayer for playing recorded livestream videos. It works seamlessly with AVPlayerViewController.