Skip to content

Remove unnecessary indents in README. #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove unnecessary indents in README. #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 77 additions & 77 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,105 +13,105 @@ Records RTSP Audio/Visual Streams to local disk using ffmpeg
## Installation

```shell
$ npm install --save node-rtsp-recorder
$ npm install --save node-rtsp-recorder
```

## Recording Video

```js
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
})
// Starts Recording
rec.startRecording();

setTimeout(() => {
console.log('Stopping Recording')
rec.stopRecording()
rec = null
}, 300000)
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
})
// Starts Recording
rec.startRecording();

setTimeout(() => {
console.log('Stopping Recording')
rec.stopRecording()
rec = null
}, 300000)
```

## Recording Audio

```js
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
type: 'audio',
})
rec.startRecording();

setTimeout(() => {
console.log('Stopping Recording')
rec.stopRecording()
rec = null
}, 125000)
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
type: 'audio',
})

rec.startRecording();

setTimeout(() => {
console.log('Stopping Recording')
rec.stopRecording()
rec = null
}, 125000)
```

## Capturing Image

```js
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
type: 'image',
})

rec.captureImage(() => {
console.log('Image Captured')
})
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
type: 'image',
})

rec.captureImage(() => {
console.log('Image Captured')
})
```

## Managing Media Directory

```js
const FileHandler = require('../src/helpers/fileHandler')
const fh = new FileHandler()
// RETURNS DIRECTORY SIZE
fh.getDirectorySize('/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos/', (err, value) => {
if (err) {
console.log('Error Occured')
console.log(err)
return true
}
console.log('Folder Size is ' + value)
})
// REMOVES ALL MEDIA FILES
fh.removeDirectory('/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos/*', () => {
console.log('Done')
})
const FileHandler = require('../src/helpers/fileHandler')
const fh = new FileHandler()
// RETURNS DIRECTORY SIZE
fh.getDirectorySize('/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos/', (err, value) => {
if (err) {
console.log('Error Occured')
console.log(err)
return true
}
console.log('Folder Size is ' + value)
})
// REMOVES ALL MEDIA FILES
fh.removeDirectory('/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos/*', () => {
console.log('Done')
})
```

### Setting custom filename formats

```js
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
directoryPathFormat: 'MMM-D-YYYY',
fileNameFormat: 'M-D-h-mm-ss',
})
// Default directoryPathFormat : MMM-Do-YY
// Default fileNameFormat : YYYY-M-D-h-mm-ss
// Refer to https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/ for custom formats.
// Starts Recording
rec.startRecording();
```
const Recorder = require('node-rtsp-recorder').Recorder

var rec = new Recorder({
url: 'rtsp://192.168.1.12:8554/unicast',
timeLimit: 60, // time in seconds for each segmented video file
folder: '/Users/sahilchaddha/Sahil/Projects/Github/node-rtsp-recorder/videos',
name: 'cam1',
directoryPathFormat: 'MMM-D-YYYY',
fileNameFormat: 'M-D-h-mm-ss',
})
// Default directoryPathFormat : MMM-Do-YY
// Default fileNameFormat : YYYY-M-D-h-mm-ss
// Refer to https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/ for custom formats.
// Starts Recording
rec.startRecording();
```