Skip to content

Commit

Permalink
Add 2 missing sections, add titles, update index, adjust css for tabl…
Browse files Browse the repository at this point in the history
…es & headings
  • Loading branch information
dondizon committed Jan 22, 2016
1 parent 0b75288 commit 386fc3c
Show file tree
Hide file tree
Showing 15 changed files with 160 additions and 174 deletions.
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ description: > # this means to ignore newlines until "baseurl:"
San Diego, CA 92109, California, USA.
baseurl: "/ems_user_guide" # the subpath of your site, e.g. /blog
url: "http://evostream.github.io" # the base hostname & protocol for your site
#baseurl: "" # for local test only
#url: "http://localhost:4000" # for local test only
twitter_username: EvoStreamInc
github_username: EvoStream

Expand Down
4 changes: 1 addition & 3 deletions _posts/2016-01-01-capabilities.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title:
title: Capabilities
layout: post
categories: jekyll update
permalink: Capabilities
---

## Capabilities

### Lazy Pull - .vod Files

Lazy Pull is used to perform `pullStream` commands on demand. This feature allows you to conserve your bandwidth by only pulling streams when they are actually requested by clients!
Expand Down
78 changes: 3 additions & 75 deletions _posts/2016-01-01-configfiles.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
title:
title: Configuration Files
layout: post
date: 2016-01-01 00:00:00 +0000
categories: jekyll update
permalink: config
permalink: configfiles
---

## Configuration Files

### Primary Config (config.lua (Primary Config))
### Primary Config (config.lua)

The config.lua file is a hierarchical data structure of assignments (key names with values). It is sent as a parameter when running the EvoStream server. The format is as follows:

Expand Down Expand Up @@ -997,74 +995,4 @@ The EWS can allow or disallow access to files based upon defined white lists or

### server.key

## Interoperability

### Stream Sources

Flash Media Live Encoder (FMLE) – RTSP, RTMP, MPEG-TS
Flash Media Server (FMS) – RTSP, RTMP, MPEG-TS
Discover Video Multimedia Encoder (DVME) – RTSP, RTMP, MPEG-TS
VLC – RTSP, RTMP, Mpeg-TS
Wowza – RTSP, RTMP, Mpeg-TS
FFMpeg – MPEG-TS, RTSP
BRIA SIP Server – RTSP
IPCamera – RTSP
Wirecast – RTMP

## Stream Players

RTMP (Flash) – Adobe Flash Player, JW Player, ffPlay, Flowplayer
RTSP – Android phones (v2.3.5 or later),VLC, QuickTime, ffPlay
MPEG-TS – VLC, ffPlay
HLS – All iOS devices, iPhone, iPad, iPod Touch, JW Player
HDS – OSMF
MSS – SilverLight
DASH – GPAC, Digital Primates, castLabs DASHas

## Akamai

Akamai requires very specific settings when pushing a stream to your account. The `pushStream` command for pushing to Akamai must look like the following:

pushStream uri=rtmp://AkamaiUserName:[email protected]/EntryPoint localStreamname=YourLocalStream targetStreamName=XX_YY_ZZ@WW emulateUserAgent=FMLE/3.0\ (compatible;\ FMSc/1.0)

AkamaiuserName, AkamaiPass, `YOUR.akamaientrypoint.net` all must be the values assigned to you by Akamai.

For the `targetStreamName`, xx, yy, zz are arbitrary strings, but Akamai requires there to be exactly two "_" in the stream name. @ww is a unique number used in combination with username/password to allow/disallow the publish operation. It is mandatory and is provided to you by Akamai.

The EMS can also push to the new RTMP HD publishing points in Akamai. You need to set the parameter `sendChunkSizeRequest` to `0` for Akamai to accept the connection. The `pushStream` command for this looks like the following:

pushStream uri=rtmp://AkamaiUserName:[email protected]/EntryPoint localStreamname=YourLocalStream targetStreamName=XX_YY_ZZ@WW emulateUserAgent=FMLE/3.0\ (compatible;\ FMSc/1.0) sendChunkSizeRequest=0Other CDNs

The EMS allows you to publish your streams to a wide variety of CDNs. These include:

- YouTubeLive
- Limelight
- Twitch.tv
- EdgeCast
- And many more!

Often times pushing streams to these CDNs is very simple and only requires you to add your username and password to the RTMP pushStream command (See RTMP section above). For many of these CDNs, you will need to specify emulateUserAgent in your pushStream command. An example pushStream command is as follows:

pushStream uri=rtmp://UserName:Pass@EntryPoint localStreamname=YourLocalStream targetStreamName=UsuallySpecifiedInYourAccount emulateUserAgent=FMLE

## Miscellaneous Examples

To play an mpegts stream in VLC, use:

udp://@239.1.1.1:1234

To create a stream out of a file with ffmpeg, use:

$ ffmpeg -re -i myMovie.mp4 -acodec copy -vcodec copy -f mpegts -vbsf h264_mp4toannexb "udp://192.168.1.16:5555/"

To play HLS, send telnet command to EMS:

1. Create HLS:

createhlsstream localstreamnames=teststream targetfolder=/var/www/html groupname=testgroup playlisttype=rolling

2. Verify: Check if .ts files are generated inside targetfolder.
3. Play: In the browser, type the complete URI of the "targetfolder/groupname" where `playlist.m3u8` is located.

**PLEASE SEE THE "HOW TO" DOCUMENT FOR MORE EXCELLENT EXAMPLES!**

4 changes: 1 addition & 3 deletions _posts/2016-01-01-emsbasics.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title:
title: EMS Basics
layout: post
date: 2016-01-01 00:00:00 +0000
categories: jekyll update
permalink: emsbasics
---

# EMS Basics

There are a number of things that are good to keep in mind when interacting with the EvoStream Media Server.

## Streams
Expand Down
4 changes: 1 addition & 3 deletions _posts/2016-01-01-eventnotification.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title:
title: Event Notification System
layout: post
date: 2016-01-01 00:00:00 +0000
categories: jekyll update
permalink: eventnotification
---

## Event Notification System

The EMS Event Notification System provides an extremely powerful way of interacting with the EMS. At the basic level it allows you to easily understand and monitor the usage of your server. You can either poll and parse the log file, or simply subscribe to the HTTP based notifications sent out by the EMS. **The notifications mean that you can have a fully RESTful monitor, gathering metrics in real time!**

Beyond monitoring and gathering metrics, you can **use the Event Notification System to create custom stream processing.** If you want to automatically create HLS/HDS/MSS/DASH streams out of new inbound streams, simply call createHLSStream/createHDSStream/createMSSStream/createDASHStream in response to each "new inbound stream" event. If you want to close inbound streams when the associated outbound stream is lost, call shutdownStream when you receive an "outbound stream closed" event.
Expand Down
58 changes: 0 additions & 58 deletions _posts/2016-01-01-index-local.md

This file was deleted.

57 changes: 47 additions & 10 deletions _posts/2016-01-01-index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
layout: post
title: "EMS User Guide"
title: EMS User Guide
date: 2016-01-01 01:01:01 +0000
categories: jekyll update
permalink: table_of_contents
---

1. [Introduction](/ems_user_guide/introduction)
1. [Introduction]({{site.url}}{{site.baseurl}}/introduction)
- Document Definitions
- Purpose
- EvoStream Media Server
Expand All @@ -15,44 +15,81 @@ permalink: table_of_contents
- What are the Key Features and Benefits of the EMS?
- How Does the EMS Work?
- Where will EMS Run?
2. [Installation and Startup](/ems_user_guide/installation)
2. [Installation and Startup]({{site.url}}{{site.baseurl}}/installation)
- Obtain a License
- Install EMS
- Other Installers
- Platform Verification
- Linux Limitations
- Distribution Content
3. [Starting the Server](/ems_user_guide/startingserver)
3. [Starting the Server]({{site.url}}{{site.baseurl}}/startingserver)
- Linux Distributions (Linux apt/yum Installer)
- Linux, Mac OSX and BSD Distributions (.tar.gz Distribution)
- Windows Distribution
- Startup Success
- EMS Command Line Definition
4. [EMS Basics](/ems_user_guide/emsbasics)
4. [EMS Basics]({{site.url}}{{site.baseurl}}/emsbasics)
- Streams
- Config Files
- Video Compression
- Production Logging
- Debug Logging
5. [Run-Time API](/ems_user_guide/runtimeapi)
5. [Run-Time API]({{site.url}}{{site.baseurl}}/runtimeapi)
- Accessing the Runtime API
- Configuring and Receiving Event Notifications
- API Definition
- My First Call API
- User Defined Variables
- EMS Demo.html
6. [Event Notification System](/ems_user_guide/eventnotification)
6. [Event Notification System]({{site.url}}{{site.baseurl}}/eventnotification)
- List of Events
- Configuring Event Notifications
- Application vs. Server Events
7. [Security and Authentication](/ems_user_guide/security)
7. [Security and Authentication]({{site.url}}{{site.baseurl}}/security)
- Stream Aliasing
- Group Name Aliasing
- Inbound Authentication
- Outbound Authentication
- Client Authentication
- Encoder/User Agents 3736
8. [Protocol Support and Specifics](/ems_user_guide/protocolsupport)
8. [Protocol Support and Specifics]({{site.url}}{{site.baseurl}}/protocolsupport)
- Peer to Peer
- HTML5 Web Sockets

9. [Configuration Files]({{site.url}}{{site.baseurl}}/configfiles)
- Primary Config (config.lua)
- logAppenders
- applications
- application Definition
- media
- acceptors
- autoHLS/HDS/DASH/MSS
- authentication
- eventLogger
- Event Sinks
- Transcoder
- drm
- [Web Server Configuration (webconfig.lua)]({{site.url}}{{site.baseurl}}/configfiles#web-server-configuration-webconfiglua)
- Contents
- logAppenders
- applications
- webServer Application
- supportedMimeTypes
- includeResponseHeaders
- apiProxy
- pushPullSetup.xml
- connLimits.xml
- users.lua (Authentication)
- pushPullSetup.xml
- auth.xml
- bandwidths.xml
- blacklist.txt
- whitelist.txt
- ingestpoints.xml
- server.cert
- server.key
10. [Interoperability]({{site.url}}{{site.baseurl}}/interoperability)
- [Stream Sources]({{site.url}}{{site.baseurl}}/interoperability#stream-sources)
- [Stream Players]({{site.url}}{{site.baseurl}}/interoperability#stream-players)
- [Akamai]({{site.url}}{{site.baseurl}}/interoperability#akamai)
- [Other CDNs]({{site.url}}{{site.baseurl}}/interoperability#other-cdns)
- [Miscellaneous Examples]({{site.url}}{{site.baseurl}}/interoperability#miscellaneous-examples)
4 changes: 1 addition & 3 deletions _posts/2016-01-01-installation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title:
title: Installation and Startup
layout: post
date: 2016-01-01 00:00:00 +0000
categories: jekyll update
permalink: installation
---

## Installation and Startup

### Obtain a License

A license file is required to run EMS. EvoStream offers 30-day trial licenses which can be obtained from the EvoStream website: [https://evostream.com/free-trial/](https://evostream.com/free-trial/)
Expand Down
Loading

0 comments on commit 386fc3c

Please sign in to comment.