Metadata-Version: 2.4
Name: stream_saver_g4
Version: 1.1.0
Summary: Save stream to disk
Home-page: https://github.com/Genzo4/stream_saver
Author: Genzo
Author-email: genzo@bk.ru
License: MIT
Project-URL: Bug Tracker, https://github.com/Genzo4/stream_saver/issues
Keywords: stream saver,stream,ffmpeg-python,ffmpeg,g4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ffmpeg-python
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

![Language](https://img.shields.io/badge/English-brigthgreen)

# Stream saver

![PyPI](https://img.shields.io/pypi/v/stream-saver-g4)
![PyPI - License](https://img.shields.io/pypi/l/stream-saver-g4)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stream-saver-g4)

Python module for save stream to disk

***

## Installation

### Package Installation from PyPi

```bash
$ pip install stream-saver-g4
```

### Package Installation from Source Code

The source code is available on [GitHub](https://github.com/Genzo4/stream_saver).  
Download and install the package:

```bash
$ git clone https://github.com/Genzo4/stream_saver
$ cd stream_saver
$ pip install -r requirements.txt
$ pip install .
```

***

## Basic usage

- ### Import:
```python
from stream_saver_g4 import StreamSaver
```

- ### Create instance:
Create an instance of the StreamSaver. You can specify additional options:
- stream_URL - Stream URL.
  Default value: ''
- output_template - Output template.
  Default value: 'output_%Y-%m-%d_%H-%M-%S.ts'
- segment_time - Segment length.
  Default value: '01:00:00'


```python
stream = StreamSaver(stream_URL='rtsp://cam_1.local:554/live1.sdp',
                     output_template='output_%H-%M-%S.ts',
                     segment_time='00:30:00'
                     )
```

- ### Run saving stream
Stream saving is running in the background.

```python
stream.run()
```

- ### Stop saving stream

```python
stream.stop()
```

[Changelog](https://github.com/Genzo4/stream_saver/blob/main/CHANGELOG.md)
***

![Language](https://img.shields.io/badge/Русский-brigthgreen)

# Stream saver

![PyPI](https://img.shields.io/pypi/v/stream-saver-g4)
![PyPI - License](https://img.shields.io/pypi/l/stream-saver-g4)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stream-saver-g4)

Python модуль для сохранения видеопотока на диск.

***

## Установка

### Установка пакета с PyPi

```bash
$ pip install stream-saver-g4
```

### Установка пакета из исходного кода

Исходный код размещается на [GitHub](https://github.com/Genzo4/stream_saver).  
Скачайте его и установите пакет:

```bash
$ git clone https://github.com/Genzo4/stream_saver
$ cd stream_saver
$ pip install -r requirements.txt
$ pip install .
```

***

## Использование

- ### Подключаем:
```python
from stream_saver_g4 import StreamSaver
```

- ### Создаём экземпляр
Создаём экземпляр StreamSaver. Можно указать дополнительные параметры:
- stream_URL - адрес потока.
  Значение по умолчанию: ''
- output_template - шаблон выходных файлов.
  Значение по умолчанию: 'output_%Y-%m-%d_%H-%M-%S.ts'
- segment_time - длина одного сегмента.
  Значение по умолчанию: '01:00:00'

```python
stream = StreamSaver(stream_URL='rtsp://cam_1.local:554/live1.sdp',
                     output_template='output_%H-%M-%S.ts',
                     segment_time='00:30:00'
                     )
```

- ### Запускаем сохрание потока
Сохранение потока идёт в фоновом режиме.

```python
stream.run()
```

- ### Останавливаем сохранение потока

```python
stream.stop()
```

[Changelog](https://github.com/Genzo4/stream_saver/blob/main/CHANGELOG.md)
