Skip to content

Commit 8f48334

Browse files
committed
Update README.md, add variable documentation
1 parent c2c0eca commit 8f48334

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,68 @@ ffmpeg -re -i your-input-file -vcodec libx264 -acodec aac -f flv rtmp://your-ser
184184
![rtmp-stat](https://img-blog.csdnimg.cn/20190811012138191.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ltcGluZ28=,size_16,color_FFFFFF,t_70)
185185

186186
----
187+
# 变量
188+
189+
在nginx.conf配置里可以使用变量配置,配置方式是“$”后跟变量名,如:
190+
```nginx
191+
oclp_play http://127.0.0.1:8080 stage=start args=$pargs;
192+
```
193+
194+
>这条配置中“$pargs”就是变量,含义是rtmp或http连接附加的自定义参数,例如:
195+
>
196+
>rtmp://xxx.xxx.xxx.xxx/app/name?k0=0&k1=1
197+
>$pargs会被替换成“k0=0&k1=1”
198+
199+
变量名 | 含义
200+
---|---
201+
domain | 客户端服务器时使用的域名,类似http协议中的host参数
202+
app | 挂载点名
203+
name | 流名
204+
stream | 流标识,serverid/app/name拼接而成
205+
pargs | 推流或播放请求连接后携带的自定义参数
206+
args | rtmp协议中,在connection阶段携带的参数
207+
flashver | rtmp协议中的flashver
208+
swf_url | rtmp协议中的swf_url
209+
tc_url | rtmp协议中的tc_url
210+
page_url | rtmp协议中的page_url
211+
acodecs | 音频编码类型
212+
vcodecs | 视频编码类型
213+
scheme | 连接使用的协议,如http、rtmp
214+
serverid | 配置中的serverid
215+
oclp_status | oclp执行结果
216+
finalize_reason | session被销毁的原因
217+
stage | 当前session所处的阶段:<br/>"init", "handshake_done", "connect", "create_stream", "publish", "play", "audio_video", "close_stream"
218+
init | session被初始化的时间
219+
handshake_done | rtmp握手完成时的时间
220+
connect | 连接建立的时间
221+
create_stream | 流被创建时的时间
222+
ptime | 从推流端获取到第一帧媒体数据时的时间
223+
first_data | 收到或发送第一帧媒体数据的时间
224+
first_metadata | 收到或发送metadata的时间
225+
first_audio | 收到或发送第一个音频帧的时间
226+
first_video | 收到或发送第一个视频帧的时间
227+
close_stream | 流被关闭的时间
228+
relay_domain | relay操作使用的域名,参考domain变量
229+
relay_app | relay操作使用的挂载点名,参考app变量
230+
relay_name | relay操作使用的流名,参考name变量
231+
relay_args | relay操作connection的参数,参考args变量
232+
relay_pargs | relay操作的pages参数,参考pargs变量
233+
relay_referer | relay操作的referer,参考page_url变量
234+
relay_user_agent | relay操作中User-Agent参数
235+
relay_swf_url | 参考swf_url
236+
relay_acodecs | relay操作成功后,拉取到的或推送出去的音频编码类型,参考acodecs
237+
relay_vcodecs | relay操作成功后,拉取到的或推送出去的视频编码类型,参考vcodecs
238+
remote_addr | 客户端IP
239+
remote_port | 客户端端口
240+
server_addr | 客户端通过服务器的哪个IP连接进来的
241+
server_port | 客户端通过服务器的哪个端口连接进来的
242+
nginx_version | nginx版本
243+
pid | nginx worker进程的进程号
244+
msec | 精确到微妙的时间戳,标记当前操作的精确时间
245+
time_iso8601 | iso8601标准时间
246+
time_local | 格式化的时间
247+
ngx_worker | worker进程的编号
248+
parg_ | 获取到pargs参数中的某个参数,例如pargs为k0=0&k1=1,那么$parg_k0就是0,$parg_k1就是1
187249

188250
# 全局配置
189251

0 commit comments

Comments
 (0)