# 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. {% tabs %} {% tab title="Swift" %} ```swift // `client` is AmityClient that has been initiated during the setup streamRepository = AmityStreamRepository(client: client) ``` {% endtab %} {% endtabs %} **\*Note :** There is a limitation for the maximum concurrent live events. Please feel free to reach out to us at [**community.amity.co**](https://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. ```swift 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`**. ```swift // 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`**. ```swift // 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. ```swift // Here we get AmityCollection 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. ```swift 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 {% tabs %} {% tab title="v6.19.0 and above" %} Use AmityVideoPlayer to play a live stream. {% embed url="" %} {% endtab %} {% tab title="Deprecated" %} To play a live stream, currently only RTMP protocol is supported, call * **`stream.watcherUrl`** **`AmityLiveStreamURLInfo`** contains a full RTMP url, which most of RTMP players support. For some players that does not support the full url, this object contains enough data for custom RTMP url formatting. ```swift 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) } ``` **`AmityStream`** has **`isLive`** property**.** * When there is an update of live object, use **`isLive`** property to check. * When there is an update of live stream collections: * The streams that are not live, will disappear from the collection. * The streams that are just live, will appear in the collection. ```swift if (stream.isLive) { print("The stream is live now.") } ``` ## Recommended RTMP players RTMP is a low-latency video streaming protocol, that iOS does not support in its native video player. Therefore when working with RTMP, here are some open-source players that we recommend: * [MobileVLCKit](https://code.videolan.org/videolan/VLCKit) * [SGPlayer](https://github.com/libobjc/SGPlayer) * [HaishinKit](https://github.com/shogo4405/HaishinKit.swift) {% endtab %} {% endtabs %} ## 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. {% embed url="" %} {% tabs %} {% tab title="v6.19.0 and above" %} Use AmityRecordedStreamPlayer to play recorded videos. If the live stream session contains multiple recorded video, player will play one video after another. {% embed url="" %} {% endtab %} {% tab title="Deprecated" %} Each live stream session can contain multiple recorded videos. You can retrieve the array of **`AmityLiveVideoRecordingData`** that store all recording data, by calling * **`stream.recordingData`** To get the actual url, you need to specify the file format by calling on a recorded item. * **`recordingItem.url(for: AmityLiveVideoRecordingFileFormat)`** The following code shows an example of getting all the mp4 url of a stream instance. ```swift // 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") } } ``` {% hint style="info" %} In contrast with RTMP live videos, you don't need 3rd party video players for the recorded videos. iOS native players already support playing mp4 file from the URL given by API. *See also* [*AVFoundation*](https://developer.apple.com/documentation/avfoundation) *and* [*AVKit*](https://developer.apple.com/documentation/avkit/)*.* {% endhint %} {% endtab %} {% endtabs %} ## 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](https://docs.amity.co/installation-and-authentication/install-ios-sdk#additional-steps-for-amity-video). ## 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. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.social.plus/~/changes/5GVz91dkzloMulIORPZq/amity-sdk/video/ios/view-play.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.