Dokumentation
IPS_GetMedia
array IPS_GetMedia (int $MedienID)
Parameterliste
| MedienID | ID des Medienobjekts |
Rückgabewert
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 | ||||||||||||||||||
| MediaSize | integer | Größe in Byte | ||||||||||||||||||
| MediaType | integer | Medien-Typ
|
||||||||||||||||||
| 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) |
Beschreibung
Die Funktion liefert ein Array mit Informationen über das Medienobjekt mit der ID MedienID.
Ab Version 4.0 wird die bis 3.4 vorhandene Funktion als
"array IPS_GetMediaCompatibility( integer $MedienID )" zur Verfügung gestellt.
Beispiel
// 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] =>
)
*/