Stream Limit API

Example of a simple implementation to build a stream limit api on top of Redis

Related repositories

• Favorites API
• Ratings API
• Continue Watching API
• User Segmentation API
• Recommendation Engine

Requirements

• nodejs v10+
• redis

Usage

• git clone git@github.com:Eyevinn/stream-limit-api.git
• cd stream-limit-api
• npm install
• Start Redis locally or insert the needed keys into the .env file
• npm start to run the server

Endpoints

• POST /sessions/:userId/start/:deviceId To start a session
• POST /sessions/:userId/ping/:deviceId To keep the session alive
• POST /sessions/:userId/end/:deviceId To end a session
• POST /sessions/:userId/kill/:deviceId To kill a session
• GET /sessions/:userId/list To get a user's ongoing sessions

Environment variables

• NODE_ENV if set to development there will be some logging made into the console
• REDIS_URL if not local
• REDIS_PORT if not default (6379)
• REDIS_AUTH
• STREAM_LIMIT To set the limitation in maximum amount of sessions per user (default 2)
• PING_INTERVAL The interval to wait for the next ping, without killing the session (default 10 seconds)

Docker

A docker-compose config file is provided that takes care of building the image and running this container together with a Redis db container.

Start the service:

• docker-compose up

Stop the service:

• docker-compose down

The Redis container is using /tmp as persistant storage but this can be changed by modifying the docker-compose.yml file. Change:

    volumes:
      - /tmp:/bitnami/redis/data

to where you want the persistant storage to be located.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor.

At Eyevinn, every software developer consultant has a dedicated budget reserved for open source development and contribution to the open source community. This give us room for innovation, team building and personal competence development. And also gives us as a company a way to contribute back to the open source community.

Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!