# Medienverwaltung

> Symcon Dokumentation · Deutsch · erzeugt am 2026-09-26  
> Index: https://www.symcon.de/de/llms.txt

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/

## IPS_CreateMedia

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-createmedia/

`int IPS_CreateMedia(int $MedienTyp)`

legt ein neues Medienobjekt im MedienPool an

**Parameter**

- `$MedienTyp` (int)

  | Wert | Beschreibung                     |
  | ---- | -------------------------------- |
  | 0    | Legt ein __IPSView Formular__ an |
  | 1    | Legt ein __Image Objekt__ an     |
  | 2    | Legt ein __Sound Objekt__ an     |
  | 3    | Legt ein __Stream Objekt__ an    |
  | 4    | Legt ein __Chart Objekt__ an     |
  | 5    | Legt ein __Dokument Objekt__ an  |

**Rückgabewert** (int): ID des neu erstellten Medienobjekts

| Wert | Beschreibung                     |
| ---- | -------------------------------- |
| 0    | Legt ein __IPSView Formular__ an |
| 1    | Legt ein __Image Objekt__ an     |
| 2    | Legt ein __Sound Objekt__ an     |
| 3    | Legt ein __Stream Objekt__ an    |
| 4    | Legt ein __Chart Objekt__ an     |
| 5    | Legt ein __Dokument Objekt__ an  |

**Beispiel**

```php
// Anlegen eines neuen Links mit dem Namen "Alarm"
$ImageFile = "C:\\Bilder\\Alarmsymbol.png";     // Image-Datei
$MediaID = IPS_CreateMedia(1);                  // Image im MedienPool anlegen
IPS_SetMediaFile($MediaID, $ImageFile, true);   // Image im MedienPool mit Image-Datei verbinden
IPS_SetName($MediaID, "Alarm");                 // Medienobjekt benennen
IPS_SetParent($MediaID, 12345);                 // Medienobjekt einsortieren unter dem Objekt mit der ID "12345"
```

## IPS_DeleteMedia

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-deletemedia/

`bool IPS_DeleteMedia(int $MedienID, bool $DateiLöschen)`

löscht ein Medienobjekt aus dem MedienPool

**Parameter**

- `$MedienID` (int): ID des zu löschenden Medienobjekts
- `$DateiLöschen` (bool): __TRUE__, wenn Datei gelöscht werden soll; __FALSE__, wenn die Datei in den ‘deleted’ Ordner verschoben werden soll

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

__TRUE__, wenn Datei gelöscht werden soll; __FALSE__, wenn die Datei in den ‘deleted’ Ordner verschoben werden soll

**Beispiel**

```php
IPS_DeleteMedia($MediaID, true);
```

## IPS_GetMedia

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmedia/

`array IPS_GetMedia(int $MedienID)`

liefert umfassende Information über ein bestimmtes Medienobjekt

**Parameter**

- `$MedienID` (int): Die zu zeigende MedienID

**Rückgabewert** (array): Folgende Informationen stehen als __key => value__ Paare zur Verfügung:

| Index                         |  Typ    | Beschreibung                                                                                                                           |
| ----------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| __IsAvailable__ (bis 3.4)     | boolean | TRUE, wenn MediaFile vorhanden (ab Version 4.0 ersetzt durch MediaIsAvailable)                                                         |
| __IsLinked__ (bis 3.4)        | boolean | TRUE, wenn Datei außerhalb des Media Ordners liegt (entfällt ab Version 4.0)                                                           |
| __LastUpdate__ (bis 3.4)      | integer | Unix Timestamp der letzten Aktualisierung (ab Version 4.0 ersetzt durch MediaUpdated)                                                  |
| __MediaCRC__                  | string  | CRC32 der Datei                                                                                                                        |
| __MediaFile__                 | string  | Pfad zur Datei                                                                                                                         |
| __MediaID__                   | integer | MediaID                                                                                                                                |
| __MediaIsAvailable__ (ab 4.0) | boolean | TRUE, wenn MediaFile vorhanden                                                                                                         |
| __MediaIsCached__ (ab 4.0)    | boolean | TRUE, wenn das Medienobjekt in den Arbeitsspeicher geladen werden soll. Siehe [IPS_SetMediaCached](management-media.md) |
| __MediaSize__                 | integer | Größe in Byte                                                                                                                          |
| __MediaType__                 | integer | Medien-Typ (0: Formular, 1: Bild, 2: Ton, 3: Stream, 4: Chart, 5: Dokument)                                                            |
| __MediaUpdated__ (ab 4.0)     | integer | Unix Timestamp der letzten Aktualisierung                                                                                              |
| __SendEvent__ (bis 3.4)       | boolean | TRUE, wenn automatisch Dateiänderungen versendet werden sollen (entfällt ab Version 4.0)                                               |

Die zu zeigende MedienID

**Beispiel**

```php
// Ab Version 4.0
print_r(IPS_GetMedia(45699));
/* Beispielausgabe:
Array
(
    [MediaCRC] => E2D2C1D1
    [MediaFile] => media\45699.bin
    [MediaID] => 45699
    [MediaIsAvailable] => 1
    [MediaIsCached] =>
    [MediaSize] => 8192
    [MediaType] => 0
    [MediaUpdated] => 1214421546
)
*/

print_r(IPS_GetMediaCompatibility(45699));
/* Beispielausgabe:
Array
(
    [IsAvailable] => 1
    [IsLinked] =>
    [LastUpdate] => 1214421546
    [MediaCRC] => E2D2C1D1
    [MediaFile] => media\45699.bin
    [MediaID] => 45699
    [MediaSize] => 8192
    [MediaType] => 0
    [SendEvent] =>
)
*/

// Bis Version 3.4
print_r(IPS_GetMedia(45699));
/* Beispielausgabe:
Array
(
    [IsAvailable] => 1
    [IsLinked] =>
    [LastUpdate] => 1214421546
    [MediaCRC] => E2D2C1D1
    [MediaFile] => media\45699.bin
    [MediaID] => 45699
    [MediaSize] => 8192
    [MediaType] => 0
    [SendEvent] =>
)
*/
```

## IPS_GetMediaContent

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmediacontent/

`string IPS_GetMediaContent(int $MedienID)`

_Benötigt Symcon >= 3.1_

liefert den Inhalt eines Medienobjekts

**Parameter**

- `$MedienID` (int): ID des Medienobjekts, dessen Inhalt geliefert werden soll

**Rückgabewert** (string): Der Inhalt des Medienobjekts in Base64 kodiert

ID des Medienobjekts, dessen Inhalt geliefert werden soll

**Beispiel**

```php
$Inhalt = base64_decode(IPS_GetMediaContent($MediaID));
```

## IPS_GetMediaID

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmediaid/

`int IPS_GetMediaID(string $MedienName)`

ermittelt die ID eines Medienobjekts

**Parameter**

- `$MedienName` (string): Zu suchender Medienname

**Rückgabewert** (int): ID des gefundenen Medienobjekts, sonst 0

Zu suchender Medienname

**Beispiel**

```php
$MediaID = IPS_GetMediaID("Regenmenge");
if ($MediaID == 0)
    echo "Medienobjekt nicht gefunden!";
else
    echo "Die Medienobjekt-ID lautet: ". $MediaID;
```

## IPS_GetMediaIDByFile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmediaidbyfile/

`int IPS_GetMediaIDByFile(string $MedienPfad)`

ermittelt die ID eines Medienobjekts anhand der Datei

**Parameter**

- `$MedienPfad` (string): Relativer MedienPfad vom KernelDir gesehen

**Rückgabewert** (int): ID des gefundenen Medienobjekts, sonst 0 und Warning

Relativer MedienPfad vom KernelDir gesehen

**Beispiel**

```php
$MediaID = @IPS_GetMediaIDByFile("media\\help.png");
if ($MediaID == 0)
    echo "Bild nicht gefunden!";
else
    echo "Die Media-ID lautet: ". $MediaID;
```

## IPS_GetMediaIDByName

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmediaidbyname/

`int IPS_GetMediaIDByName(string $MedienName, int $ÜbergeordneteID)`

ermittelt die ID eines Medienobjekts anhand des Namens

**Parameter**

- `$MedienName` (string): Zu suchender MedienName
- `$ÜbergeordneteID` (int): Objekt, in deren direkten Unterobjekten gesucht werden soll

**Rückgabewert** (int): ID des gefundenen Medienobjekts, sonst FALSE

Objekt, in deren direkten Unterobjekten gesucht werden soll

**Beispiel**

```php
$MedienID = @IPS_GetMediaIDByName("MeinBild", $ÜbergeordneteID);
if ($MedienID === false)
    echo "Bild nicht gefunden!";
else
    echo "Die Media-ID lautet: ". $MedienID;
```

## IPS_GetMediaList

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmedialist/

`array IPS_GetMediaList()`

liefert eine Liste aller Medienobjekte im MedienPool

**Rückgabewert** (array): Ein Array von Integer-Werten aller IDs der Medienobjekte in IP-Symcon

Die Funktion ermittelt die IDs aller im MedienPool registrierten Medienobjekte. Die IDs werden in einem Array aufgelistet. Falls kein Medienobjekt existiert, ist das Array leer.

Es werden Objekte aller Medientypen aufgelistet. Sollen nur Objekte eines bestimmten Medientyps berücksichtigt werden, so kann hierfür die Funktion [IPS_GetMediaListByType](management-media.md) verwendet werden.

**Beispiel**

```php
$alleMedienobjekte = IPS_GetMediaList();
print_r($alleMedienobjekte);

/* liefert z.B.:
Array
(
    [0] => 37659
    [1] => 18326
    usw. ...
*/
```

## IPS_GetMediaListByType

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmedialistbytype/

`array IPS_GetMediaListByType(int $MedienTyp)`

liefert eine Liste aller Medienobjekte eines bestimmten Typs

**Parameter**

- `$MedienTyp` (int)

  | Wert | Beschreibung     |
  | ---- | ---------------- |
  | 0    | IPSView Formular |
  | 1    | Image Objekt     |
  | 2    | Sound Objekt     |
  | 3    | Stream Objekt    |
  | 4    | Chart Objekt     |
  | 5    | Dokument Objekt  |

**Rückgabewert** (array): Ein Array von Integer-Werten aller IDs der Medienobjekt vom Typ __MedienTyp__ in IP-Symcon

| Wert | Beschreibung     |
| ---- | ---------------- |
| 0    | IPSView Formular |
| 1    | Image Objekt     |
| 2    | Sound Objekt     |
| 3    | Stream Objekt    |
| 4    | Chart Objekt     |
| 5    | Dokument Objekt  |

**Beispiel**

```php
$alleImageObjekte = IPS_GetMediaListByType(1); // nur Image-Objekte auflisten
print_r($alleImageObjekte);

/* liefert z.B.:
Array
(
    [0] => 37659
    [1] => 18326
    usw. ...
)
*/
```

## IPS_MediaExists

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-mediaexists/

`bool IPS_MediaExists(int $MedienID)`

prüft, ob sich ein bestimmtes Medienobjekt bereits im MedienPool befindet

**Parameter**

- `$MedienID` (int): ID des zu rüfenden Medienobjekts

**Rückgabewert** (bool): Falls die MedienID im System existiert, wird __TRUE__ zurückgemeldet, andernfalls __FALSE__.

ID des zu rüfenden Medienobjekts

**Beispiel**

```php
if (IPS_MediaExists(34881))
    echo "Ein Medienobjekt mit dieser ID existiert!";
```

## IPS_SendMediaEvent

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-sendmediaevent/

`bool IPS_SendMediaEvent(int $MedienID)`

sendet eine Mitteilung, dass ein Medienobjekt sich geändert hat

**Parameter**

- `$MedienID` (int): ID des zu prüfenden Medienobjekts

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

ID des zu prüfenden Medienobjekts

**Beispiel**

```php
IPS_SendMediaEvent(12345);
```

## IPS_SetMediaCached

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-setmediacached/

`bool IPS_SetMediaCached(int $MedienID, bool $CacheAktiviert)`

aktiviert, dass ein Medienobjekt nur im Arbeitsspeicher bearbeitet wird

**Parameter**

- `$MedienID` (int): ID des zu verändernden Medienobjekts
- `$CacheAktiviert` (bool): __TRUE__, wenn das Medienobjekt nur im Cache verarbeitet werden soll, sonst __FALSE__

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

__TRUE__, wenn das Medienobjekt nur im Cache verarbeitet werden soll, sonst __FALSE__

**Beispiel**

```php
$MediaID = IPS_CreateMedia(1); // Image im MedienPool anlegen
IPS_SetMediaCached($MediaID, true);
// Das Cachen für das Mediaobjekt wird aktiviert.
// Beim ersten Zugriff wird dieses von der Festplatte ausgelesen
// und zukünftig nur noch im Arbeitsspeicher verarbeitet.
```

## IPS_SetMediaContent

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-setmediacontent/

`bool IPS_SetMediaContent(int $MedienID, string $Inhalt)`

_Benötigt Symcon >= 3.1_

setzt den Inhalt eines Medienobjekts

**Parameter**

- `$MedienID` (int): ID des Medienobjekts, dem der Inhalt zugeordnet werden soll
- `$Inhalt` (string): Base64 kodierter Inhalt

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

Base64 kodierter Inhalt

**Beispiel**

```php
$MediaID = IPS_CreateMedia(1); //Bild hochladen
IPS_SetMediaFile($MediaID, "BlackPixel.gif", False);
IPS_SetMediaContent($MediaID, "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs=");
```

## IPS_SetMediaFile

Quelle: https://www.symcon.de/de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-setmediafile/

`bool IPS_SetMediaFile(int $MedienID, string $DateiName, bool $DateiMussExistieren)`

bindet eine Mediendatei an ein Medienobjekt

**Parameter**

- `$MedienID` (int): ID des zu verändernden Medienobjekts
- `$DateiName` (string): Dateiname/-pfad der zu verknüpfenden Datei
- `$DateiMussExistieren` (bool): __TRUE__, wenn Existenz geprüft werden soll, sonst __FALSE__

**Rückgabewert** (bool): Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis __TRUE__, andernfalls __FALSE__.

__TRUE__, wenn Existenz geprüft werden soll, sonst __FALSE__

**Beispiel**

```php
$ImageFile = "Alarmsymbol.png"; // Image-Datei
$MediaID = IPS_CreateMedia(1); // Image im MedienPool anlegen
IPS_SetMediaFile($MediaID, $ImageFile, true); // Image im MedienPool mit Image-Datei verbinden
```