AirenSoft / OvenMediaEngine

OvenMediaEngine (OME) is a Sub-Second Latency Live Streaming Server with Large-Scale and High-Definition. #WebRTC #LLHLS
https://airensoft.com/ome.html
GNU Affero General Public License v3.0
2.54k stars 1.06k forks source link

update the documentation regarding the 'recording(beta)' feature to clearer indicate where to set the <FILE></FILE> tags in the Server.xml #771

Closed magnuszetterberg closed 2 years ago

magnuszetterberg commented 2 years ago

I was looking into enabling the recording feature of OME. I found the documentation regarding this and simply tried to cut/paste the from the example in the documentation.

The example indicates that you can simply just paste it anywhere inside the tags. However, this is not true, since adding it ontop(but inside) these tags(there are multiple of these Publishers elements in the .xml) , will provide you with an error that this bind is not possible...

However, after looking into your bug reports, I found a ticket which had an example of a user that got this working... It then became clear that you need to put these tags at the very last element which also hosts the elements etc.

So, if any others are struggling with this, I clearly see your pain, and this could very easily be fixed by adding some clarifications on the documentations side, clearly indicating that you have to put inside this specific publisher element...

Here is my example where I pasted my tags.

<Publishers>
                                                <AppWorkerCount>1</AppWorkerCount>
                                                <StreamWorkerCount>8</StreamWorkerCount>
                                                <OVT />
                                                <WebRTC>
                                                        <Timeout>30000</Timeout>
                                                        <Rtx>false</Rtx>
                                                        <Ulpfec>false</Ulpfec>
                                                        <JitterBuffer>false</JitterBuffer>
                                                </WebRTC>
<!--                                            <HLS>
                                                        <SegmentDuration>5</SegmentDuration>
                                                        <SegmentCount>3</SegmentCount>
                                                        <CrossDomains>
                                                                <Url>*</Url>
                                                        </CrossDomains>
                                                </HLS>
                                                <DASH>
                                                        <SegmentDuration>5</SegmentDuration>
                                                        <SegmentCount>3</SegmentCount>
                                                        <CrossDomains>
                                                                <Url>*</Url>
                                                        </CrossDomains>
                                                        <UTCTiming />
                                                </DASH>
                                                <LLDASH>
                                                        <SegmentDuration>5</SegmentDuration>
                                                        <CrossDomains>
                                                                <Url>*</Url>
                                                        </CrossDomains>
                                                        <UTCTiming />
                                                </LLDASH> -->

                                                <RTMPPush>

                                        </RTMPPush>

<!-- Recording enabled -->
                        <FILE>
                                <RootPath>/mnt/shared_volumes</RootPath>
                                <FilePath>/${VirtualHost}/${Application}/${Stream}/${StartTime:YYYYMMDDhhmmss}_${EndTime:YYYYMMDDhhmmss}.ts</FilePath>
                                <InfoPath>/${VirtualHost}/${Application}/${Stream}.xml</InfoPath>
                        </FILE>
<!-- Recording enabled -->

                                        </Publishers>

Br Magnus

getroot commented 2 years ago

Could you please PR by correcting the parts that were difficult for you to understand in the document? It will be helpful to many people. Thank you.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.