Awslive::Poster

Welcome to your awslive-poster gem!. Currently there is no easy and cost effective way to get the poster image URL for a AWS medialive channel. This utility auto computes the poster URL for a AWS media channel and creates a presigned URL to access poster image.

Possible Solution and it's lacuna

Method - 1

• You can always try to scan the S3 objects to know the Latest image created to fetch it.

High Latency While fetching the Preview image as the number of object grows in S3

Method - 2

• You can subcribe for the cloud watch S3 Put Events
• Trigger a Lambda to keep track on the Latest object or move the object to specific static S3 location

You land up spinning more AWS resources and also increase your lambda usage cost

Awslive::Poster provides a simple low latency and cost effective solution to fetch the preview image for the MediaLive channel

High-Level System View

• 1 Cloudwatch Events pushed for Channel State change.

• 2 Cloudwatch Rule for channel state change triggers Channel monitor Lambda

• 3 Lambda identifies the channel Id and its start Time.

• 4 Records the Start time of the channel in a Media channel Tag with name channel_start_time

• Z Media Channel is configured for a framecapture output group that pushes the captured images onto configured S3 bucket

• A awslive-poster gem when invoked for get_url, inspects the channel and identifies the channel start time using the tag channel_start_time provisioned.

• B Once the start time is identified, awslive-poster gem computes the sequential counter and constructs the current preview presigned URL.

• C Returns the presigned URL constructed.

Prerequisites

1. Need AWS account with Key and secret holding required privileges.
2. Terraform installed.
3. Ruby 2.5 or later.
4. Git commandline

Install channel Monitor Lambda using Terraform.

$ git clone https://github.com/cloudaffair/awslive-poster.git

$ cd awslive-poster/awslive-lambda-channelmonitor/deploy

$ terraform init

$ terraform plan

$ terraform apply

Installation of Gem

Add this line to your application's Gemfile:

gem 'awslive-poster'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install awslive-poster

Usage

Awslive Poster Initialisation

require 'awslive-poster'

awslive_poster = Awslive::Poster.new(channel_id)

awslive_poster.get_url

Install channel Monitor Lambda using Terraform.

$ terraform destroy

Uninstall awlive-poster gem

$ gem uninstall awslive-poster

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cloudaffair/awslive-poster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Awslive::Poster project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.