Browse Source

README: Add usage examples.

Georgi Chorbadzhiyski 9 years ago
parent
commit
f50aa122ab
2 changed files with 45 additions and 8 deletions
  1. 44
    7
      README
  2. 1
    1
      videohubctrl.c

+ 44
- 7
README View File

8
 videohubctrl is tested with Blackmagic Design Micro Videohub 16x16
8
 videohubctrl is tested with Blackmagic Design Micro Videohub 16x16
9
 router and probably will work with other Videohub models.
9
 router and probably will work with other Videohub models.
10
 
10
 
11
-videohubctrl currently displays:
11
+videohubctrl currently displays and can configure:
12
 
12
 
13
-  - Input port labels
14
-  - Output port labels
15
-  - Output routing
16
-  - Output locking
13
+  - Video input port names
14
+  - Video output port names
15
+  - Video output routing
16
+  - Video output locking
17
 
17
 
18
 The following features found in bigger Videohub models are currently not
18
 The following features found in bigger Videohub models are currently not
19
 supported (I don't have the hardware):
19
 supported (I don't have the hardware):
55
  -i --info                  | Show device info (default command).
55
  -i --info                  | Show device info (default command).
56
  -m --monitor               | Show real time monitor for config changes.
56
  -m --monitor               | Show real time monitor for config changes.
57
 
57
 
58
-Configuration:
58
+Video input/output configuration:
59
  --vi-name <in_X> <name>    | Set video input port X name.
59
  --vi-name <in_X> <name>    | Set video input port X name.
60
  --vo-name <out_X> <name>   | Set video output port X name.
60
  --vo-name <out_X> <name>   | Set video output port X name.
61
 
61
 
85
 Example usage
85
 Example usage
86
 =============
86
 =============
87
 
87
 
88
-TODO: Add examples once set commands are done.
88
+ # Rename video output
89
+
90
+   videohubctrl -h sdi --vo-name 8 "Output 8 - test"
91
+   videohubctrl -h sdi --vo-name "Output 8 - test" "Output 8"
92
+
93
+
94
+ # Rename video input
95
+
96
+   videohubctrl -h sdi --vi-name 4 "Windows 4 HD"
97
+   videohubctrl -h sdi --vi-name "Windows 4 HD" "CPlay4"
98
+
99
+
100
+ # Lock and then unlock output 16 (unlock assumes that the port is
101
+ # named Output 16). The hostname is set via env variable.
102
+
103
+   export VIDEOHUB_HOST=sdi
104
+   videohubctrl --vo-lock 16
105
+   videohubctrl --vo-unlock "Output 16"
106
+
107
+
108
+ # Set two outputs to receive from the same input using port names
109
+
110
+   videohubctrl -h sdi --vo-route "Output 8" "Windows 4 HD"
111
+   videohubctrl -h sdi --vo-route "Output 7" "Windows 4 HD"
112
+
113
+
114
+ # Run several commands at once
115
+ # Rename video input 11 and 12
116
+ # Rename video output 5,
117
+ # Set output 5 to receive from input 12
118
+ # Lock output 5
119
+
120
+   videohubctrl --host sdi \
121
+                --vi-name 11 "Test input" \
122
+                --vi-name 12 "Playout input" \
123
+                --vo-name 5 "Encoder h264" \
124
+                --vo-route 5 12 \
125
+                --vo-lock 5
89
 
126
 
90
 
127
 
91
 Example output
128
 Example output

+ 1
- 1
videohubctrl.c View File

86
 	printf(" --list-vinputs             | List device video inputs.\n");
86
 	printf(" --list-vinputs             | List device video inputs.\n");
87
 	printf(" --list-voutputs            | List device video outputs.\n");
87
 	printf(" --list-voutputs            | List device video outputs.\n");
88
 	printf("\n");
88
 	printf("\n");
89
-	printf("Configuration:\n");
89
+	printf("Video input/output configuration:\n");
90
 	printf(" --vi-name <in_X> <name>    | Set video input port X name.\n");
90
 	printf(" --vi-name <in_X> <name>    | Set video input port X name.\n");
91
 	printf(" --vo-name <out_X> <name>   | Set video output port X name.\n");
91
 	printf(" --vo-name <out_X> <name>   | Set video output port X name.\n");
92
 	printf("\n");
92
 	printf("\n");

Loading…
Cancel
Save