---
title: "IPVideoInSystem"
description: "API documentation for IPVideoInSystem"
url: https://developer.disguise.one/python-api/docs/ipvideoinsystem/
---

# IPVideoInSystem

See also: [Video Input Guide](/plugins/guides/video-input)

Base class (inherits properties and methods): _[Subsystem](/python-api/docs/subsystem#subsystem)_

## Properties

#### **group** : _[ActiveIPVideoInGroup](/python-api/docs/activeipvideoingroup#activeipvideoingroup)_ _(Read-Only)_

## Constructors

#### **\_\_init\_\_**(self)

## Methods

#### **createNMOSIPVideoIn**(self, name: _str_) -> _str_

Creates a Persistent IP Video In which will be advertised as a receiver capable of all formats on the NMOS  
node and can be updated with details via an sdp file via the NMOS API which is used by the node

**Parameters**:

-   name: name to use for this pers record

**Returns** the receiver id NMOS will use which can be used as a reference to update this IP Video sdp via the NMOS connection API

#### **createOrUpdateVideoInFromSDP**(self, file: _str_, path: _optional\[str\] | std\_nullopt | str_, overwrite: _bool_, arg3: _bool_, sender\_id: _optional\[str\] | std\_nullopt | str_, pers: _[PersistentIPVideoIn](/python-api/docs/persistentipvideoin#persistentipvideoin)_) -> _str_

Create an IP Video In from an sdp file or apply the sdp file to an existing IP Video In. If it’s the latter it won’t  
change the path of the IP Video In.

**Parameters**:

-   file: An sdp file in string form
-   path: The path in which to create the PersistentIPVideoIn
-   overwrite: Allow it to overwrite an object with that path if it exists
-   updateNMOSConnectionAPI: If the sdp assigned is from an NMOS sender on the network, send an update to the NMOS Connection API to say the two are now connected
-   sender\_id: The sender\_id of the sender that’s connected
-   pers: If the PersistentIPVideoIn exists already and this is just an update to it, it will be passed in here

**Returns** the NMOS receiver ID of the new or existing PersistentIPVideoIn record

#### **downloadSDP**(self, url: _str_, path: _optional\[str\] | std\_nullopt | str_) -> _bool_

Download the sdp file from the url given

**Parameters**:

-   url: The sdp url
-   path: The path of the existing Persistent IP Video In to apply the sdp details to if it already exists

**Returns** Success or failure

#### **removeIPVideoInByNMOSReceiverID**(self, nmosReceiverId: _str_)

Removes a Persistent IP Video In from d3, finding it by the NMOS receiver id

**Parameters**:

-   nmosReceiverId: The NMOS receiver id which is a combination of the pers uid and the mac address of  
    the mellanox card of the machine it’s on. Note that notifyRemove will send  
    the node a message to remove the related NMOS receiver