To broadcast a live stream video, we have provided a convenient broadcaster tool called AmityStreamBroadcaster. You will need to import AmityLiveVideoBroadcastKit.framework into your app.

Authorize the required permissions

AmityStreamBroadcaster requires the following permissions to work properly.

1. Camera access

2. Microphone access

Before using AmityStreamBroadcaster, please make sure these permissions are already granted.

Here are the steps to ask for the permissions.

1. Add NSCameraUsageDescription to your app's info.plist.

2. Add NSMicrophoneUsageDescription to your app's info.plist.

3. Call AVCaptureDevice.requestAccess(for: .video, completion: ...)

4. Call AVAudioSession.sharedInstance().requestRecordPermission(_:)

Create an AmityStreamBroadcaster

You can create broadcaster instance by providing AmityClient.

broadcaster = AmityStreamBroadcaster(client: client)

Prepare a configuration

Before going live, you will need to set up the broadcaster session by creating AmityStreamBroadcasterConfiguration. This configuration will be applied for the next live session.

// Prepare configs
let config = AmityStreamBroadcasterConfiguration()
config.canvasFitting = .fill
config.bitrate = 3_000_000 // 3mbps
config.frameRate = .fps30

// Setup the next live session with the given configs.
broadcaster.setup(with: config)

Preview the video

The broadcaster object provides "preview view". After finish setting up the broadcaster, you then can take the preview view to attach into your screen.

// Attach the preview view to show on the screen.
myView.addSubview(broadcaster.previewView)

Setup video resolution

You can set up video resolution anytime "before" going live. This setting will affect both the rendering of preview view, and the resolution of live stream session.

// This settings apply the following changes.
// 1. The preview view to render at 720p.
// 2. The live stream session to broadcast at 720p.
broadcaster.videoResolution = CGSize(width: 1280, height: 720)

Start live stream session

To begin broadcasting the live stream, call

broadcaster.startPublish(title: "title", description: "description")

Stop live stream session

To stop broadcasting the live stream, call

broadcaster.stopPublish()

Switch camera position

By default, the broadcaster will use the back camera. However, you can switch camera position anytime by calling

// Use the back camera
broadcaster.cameraPosition = .back

// Use the front camera
broadcaster.cameraPosition = .front

Observe a broadcaster state

To observe a broadcaster state, we provide a delegate object that you can set to listen to broadcaster's events.

broadcaster.delegate = self

AmityStreamBroadcasterState represents all the possible states.

• .idle indicates a state of stream in an idle state.

• .connecting indicates a state of stream that it's connecting to the stream server.

• .connected indicates a state of stream that it's connected to the stream server.

• .disconnected indicates a status of stream that it's disconnected.

The code below shows an example of printing out the state of broadcaster, when it changes.

extension MyViewController: AmityStreamBroadcasterDelegate {
    
    func amityStreamBroadcasterDidUpdateState(_ broadcaster: AmityStreamBroadcaster) {
        print(broadcaster.state)
    }
    
}

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.

*Note : There is a limitation for the maximum concurrent live events. Please feel free to reach out to us at 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.

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.

Retrieve streams collection

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

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

• .getStreamsCollection(from: query)

This function returns the live collection of stream objects.

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.

Play a live stream

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.

Amity Video Player

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

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.

This functionality is not currently supported for IOS but will be coming soon! We will update the relevant sections accordingly

More than ever, videos are increasingly dominating mobile screens. From fun short-form clips to promote new products to live-streamed talk shows to educate your customers, videos have the potential to transform the way customers experience your brand.