Amazon IVS Broadcast for iOS Demo

This repository contains a demo app, which shows how to use the Amazon IVS Broadcast SDK to create a mobile streaming app on iOS using SwiftUI.

Setup

Clone the repository to your local machine.
Ensure you are using a supported version of Ruby, as the version included with macOS is deprecated. This repository is tested with the version in .ruby-version, which can be used automatically with rbenv.
Install the SDK dependency using CocoaPods. This can be done by running the following commands from the repository folder:
- pod install
- For more information about these commands, see Bundler and CocoaPods.
Open Broadcasting.xcworkspace.
Since the simulator doesn't support the use of cameras or ReplayKit, there are a couple changes you need to make before building and running the app on a physical device.
1. Have an active Apple Developer account in order to build to physical devices.
2. Modify the Bundle Identifier for both Broadcasting and ReplayKitBroadcaster targets.
3. Choose a Team for both targets.
4. Create a new App Group ID based on your new Bundle Identifier for both targets, and include the targets in only that App Group.
5. Modify appGroupName (can be found in Helpers/Constants.swift) to use your newly created App Group ID.
(Optional)* Refer to the Streaming to Amazon IVS section of this readme to set up the app for streaming.
You can now build and run the projects on a device.

_{*You can run and build this app without an Amazon IVS Channel, but you will need an Amazon IVS Channel in order to start broadcasting.}

Streaming to Amazon IVS

Prerequisites

IMPORTANT NOTE: Using your own stream will create and consume AWS resources, which will cost money.

Create and set up an Amazon IVS channel. A guide is available here: Getting started with Amazon IVS.

Referencing your stream in the app

Open the Amazon IVS Console and navigate to the channel you would like to use.
Open Helpers/Constants.swift and find lines 16 - 18.
Copy the Ingest Server for the channel and paste it into the ingestServer field on line 16 between the quotes. The resulting line should look like the following: static let ingestServer = "rtmps://<ingest_server_url>:443/app/"
Copy the Stream Key for the channel and paste it into the streamKey field on line 17 between the quotes.
Copy the Playback URL for the channel and paste it into the playbackUrl field on line 18 between the quotes.
Save and run the application.

You can also change the values for any of these fields in the app settings once you have launched the app on a physical iPhone.

Known Issues

This app has only been tested on devices running iOS 14 or later. While this app may work on devices running older versions of iOS, it has not been tested on them.

License

This project is licensed under the MIT-0 License. See the LICENSE file.

Streaming stops after the app entered background

Hi. I'm using this sample app and I've noticed that streaming stops when the app enters the background.
This seems to be unexpected behavior, because the app creates a background image before streaming in a method BroadcastViewModel.createAppBackgroundImageSource().

I believe the expected behavior is as follows:
When the app is in the background, it streams the static background image that is set up in BroadcastViewModel.createAppBackgroundImageSource().

Environment

Xcode: 14.2
iPhone 13 (physical device)
iOS 16.0

Demo app version

Latest commit in main branch: f3e3fad895694cc4254d333a625621c8be80c5a5

Amazon IVS SDK Version

AmazonIVSBroadcast 1.10.0

What I changed

Update signing.
Remove App group from Capabilities
Update ingest server and stream key (at line 16, 17 of Helpers/Constants.swift )

How to reproduce

PC: Set ingest server and stream key in Helpers/Constants.swift.
PC: Build the app.
iPhone: Launch the app.
iPhone: Start streaming by tapping the Start button.
PC: Open playback URL to watch the stream.
iPhone: Move the app to the background.

Result: The stream will stop after about 10 seconds.

What is unexpected?

Streaming stops after the app entered the background, as mentioned in How to reproduce.

What is expected?

The app will continue streaming when it's in the background.
The app will stream a static background image that is set up in BroadcastViewModel.createAppBackgroundImageSource(), while it's in the background

aws-samples / amazon-ivs-broadcast-for-ios-demo Goto Github PK