https://github.com/dimorinny/twitch-fragment-upload

Twitch stream fragment upload microservice
https://github.com/dimorinny/twitch-fragment-upload

microservice twitch video

Last synced: about 19 hours ago
JSON representation

Twitch stream fragment upload microservice

• Host: GitHub
• URL: https://github.com/dimorinny/twitch-fragment-upload
• Owner: dimorinny
• Created: 2017-02-26T23:36:18.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-03T11:03:58.000Z (over 7 years ago)
• Last Synced: 2025-01-08T10:59:53.425Z (2 days ago)
• Topics: microservice, twitch, video
• Language: Python
• Size: 23.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Twitch fragments uploader

[![](https://images.microbadger.com/badges/image/dimorinny/twitch-fragment-uploader.svg)](https://microbadger.com/images/dimorinny/twitch-fragment-uploader "Get your own image badge on microbadger.com")

Web server for uploading Twitch fragments, that can used as microservice in your applications. For load stream fragments [livestreamer](https://github.com/chrippa/livestreamer) library is used.

Supported backends for uploading:

* [VK](https://vk.com) group

* [Streamable](https://streamable.com/)

### Run server

```

docker run \

  -p 8080:8080 \

  -e "TWITCH_OAUTH=" \

  -e "TWITCH_CHANNEL=" \

  -e "UPLOAD_BACKEND=" \

  -e "VK_OAUTH=" \

  -e "VK_GROUP_ID=" \

  -e "TIMEZONE=" \

dimorinny/twitch-fragment-uploader

```

**Environment parameters:**

* **TWITCH\_OAUTH** - OAuth Twitch token

* **TWITCH\_CHANNEL** - Twitch channel name

* **UPLOAD\_BACKED** - Backend for video fragments storing. Supported values: `vk` and `streamable`

* **TIMEZONE** - Uploaded video name is generated from current date using passed timezone. For understanding timezone format you can look at [specification](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

* **RING\_BUFFER\_SIZE** - Stream buffer size. This is internal param of [livestreamer](https://github.com/chrippa/livestreamer) library. This parameter determines uploaded fragment size. (10 MB by default)

* **PORT** - Http proxy port (8080 by default)

For `vk` backend:

* **VK\_OAUTH** - OAuth Vk token **(required)**

* **VK\_GROUP** - Vk group id (without `-`), where video will be uploaded **(required)**

For `streamable` backed:

* **STREAMABLE\_USER** - Streamable login **(optional)**

* **STREAMABLE\_PASSWORD** - Streamable password **(optional)**

### Usage

For uploading stream fragment you should execute `GET` request like this:

```

http://127.0.0.1:8080/api/v1/upload

```

After that server returns uploading with video link and name. For example after success request you got response like this:

```

{

  "status": "success",

  "response": {

    "url": "https://vk.com/video_ext.php?oid=-142832429&id=456233077&hash=3d84b9ccf4e94405",

    "name": "05.03.17 22:29 cahchec"

  }

}

```

When some error occurred during recognition process you got reponse like this:

```

{

  "status": "error",

  "response": {

    "message": "Stream buffer is empty",

    "code": 100

  }

}

```

For more details you should look at stderr.