Adds a media source
Adds a media source to OBS.
Set-OBSMediaSource -FilePath My.mp4
The path to the media file.
| Type | Required | Position | PipelineInput | Aliases |
|---|---|---|---|---|
[String] |
true | 1 | true (ByPropertyName) | FullName LocalFile local_file |
If set, the source will close when it is inactive.
By default, this will be set to true.
To explicitly set it to false, use -CloseWhenInactive:$false
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, the source will automatically restart.
| Type | Required | Position | PipelineInput | Aliases |
|---|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) | Looping |
If set, will use hardware decoding, if available.
| Type | Required | Position | PipelineInput | Aliases |
|---|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) | HardwareDecoding hw_decode |
If set, will clear the output on the end of the media.
If this is set to false, the media will freeze on the last frame.
This is set to true by default.
To explicitly set to false, use -ClearMediaEnd:$false
| Type | Required | Position | PipelineInput | Aliases |
|---|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) | ClearOnEnd NoFreezeFrameOnEnd |
Any FFMpeg demuxer options.
| Type | Required | Position | PipelineInput | Aliases |
|---|---|---|---|---|
[String] |
false | 2 | true (ByPropertyName) | FFMpegOptions FFMpeg_Options |
The name of the scene.
If no scene name is provided, the current program scene will be used.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[String] |
false | 3 | true (ByPropertyName) |
The name of the input.
If no name is provided, the last segment of the URI or file path will be the input name.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[String] |
false | 4 | true (ByPropertyName) |
If set, will check if the source exists in the scene before creating it and removing any existing sources found.
If not set, you will get an error if a source with the same name exists.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will fit the input to the screen.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
Set-OBSMediaSource [-FilePath] <String> [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] <String>] [[-Scene] <String>] [[-Name] <String>] [-Force] [-FitToScreen] [<CommonParameters>]