====== Reel Item Parameters ====== ===== Introduction ===== coming soon... Descriptions given below will often refer to **items** instead of **videos** as you might expect. The reason is simple: Any item in any REEL can be a CHANNEL, VIDEO, IMAGE or even MP3 and Projekktor doesn´t mind. Some parameters apply to all, some to only a few or exactly ONE type of items. To avoid total confusion the simply call them **items** only. ---- ==== id (REQUIRED) ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items ESSENTIAL! A alphanumeric string which must be UNIQUE for any item in REEL. Is also used as stream-ID if the correspondig item is of //type// RTMP. ---- ==== file (REQUIRED) ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Fully qualified URL to an external video (for video items) or REEL resource (for channel items). ---- ==== title (REQUIRED) ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Name or title of this item as shown in info-panels and channel- or playlist- browser. ---- ==== type ==== **Type**: //String// \\ **Default Value**: flv \\ **Applies to**: all items Defines item´s type. Officially supported values are : * **flv** : Synonym for all supported video files making this item a "video" item. //file// must point to a valid media file provided via HTTP. * **rtmp** : Makes item a "video" item too but uses RTMP instead of HTTP. //file// must point to a valid RTMP repsitory then and //id// must provide a valid RTMP ID. * **channel** : Makes this item a "channel" item meaning that //file// must point to an XML file. ---- ==== created ==== **Type**: //String// \\ **Default Value**: //false// \\ **Applies to**: all types String which is shown on the playlist tiles (playlist- / channel- browser) right above the video title. ---- ==== h ==== **Type**: //Boolean// \\ **Default Value**: //false// \\ **Applies to**: video items only Hides the corresponding item while in playlist- / channel- browser but its played back once the play head reaches its position anyway. Furthermore videos with set //h// flag will also be played back if it lies between the current and the next demanded video a viewer picks while in playlist browser. So, there is no way around //h// videos. ---- ==== l ==== **Type**: //Boolean// \\ **Default Value**: //false// \\ **Applies to**: video items only Locks all control elements except "play / pause" during playback of this video. ---- ==== b ==== **Type**: //Boolean// \\ **Default Value**: //false// \\ **Applies to**: video items only Forces the player to jump back to "browser mode" once playback of this video has been completed. ---- ==== ss ==== **Type**: //String// \\ **Default Value**: //false// \\ **Applies to**: video items only Setting this parameter will enable //pseudeo// streaming for the given item. Set to //lighttp// if you are using a lightHTTP web server with FLV streaming extension. Otherwise provide a fully qualified URL to an external //pseudo streaming// script. ---- ==== info_url ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Alternate URL to load external HTML info page from. If set to //false// info for this item will be disabled. if kept //undefined// or empty the player will use the //sys_info_template// configuration parameter to generate a URL automatically. ---- ==== folder_ID ==== **reserved** ---- ==== cat ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items only Name or title of the current item´s category (e.g. 'family', 'cartoons', 'fun' or whatever). Is used to dynamically generate a category logo to be displayed within the //big screen//. May also be shown in video info header, depending on //txt_channel// parameter. ---- ==== reel_url ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items only Represents the URL to the REEL the specific item belongs to. This is intentionally used for mixed playlists containing videos taken out of different channels. Items having this parameters set do get an extra icon while in playlist- browser which enables the viewer to jump over to the specific REEL. ---- ==== channel_title ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items only Defines the title of the channel this video item belongs to. Is shown in the info section of the playlist- browser. Depends on if the %channel_title% tag is used in //txt_channel// parameter or not. Overwrites the //channel_title// configuration parameter of the currently loaded REEL. ---- ==== channel_ID ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items only Defines the ID of the channel this video item belongs to. Can be used for external tracking purposes. Overwrites the //channel_ID// configuration parameter of the currently loaded REEL (for this item only). ---- ==== channel_logo ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items only Fully qualified URL to an external image resource to use as channel logo. is shown while in //big screen// mode on position as specified by //display_logo_align// and //display_logo_valing// configuration parameter. The image will automatically scaled down to fit into the predefined logo-area. Overwrites the //channel_logo// configuration parameter of the currently loaded REEL (for this item only). ---- ==== url_homepage ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Fully qualified URL to an external web page to provide for the //"homepage"//-button. Overwrites the //url_homepage// configuration parameter of the currently loaded REEL (for this item only). ---- ==== permalink ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Fully qualified URL to provide as PERMALINK for the //"share this, link to this video"//-button. If kept empty the player will try to build the current URL by itself by appending an [anchor]+[current item id] to the current URL of the viewer´s browser. E.g. "http://www.projekktor.com/demo" will become "http://www.projekktor.com/demo#video_1". However, in some cases this method is not very reliable since its a bit tricky to avoid any security restrictions e.g. while making the URLs useable for your CMS. With //permalink// you can force the permalink-url provided to the user on server side or via the REEL xml file. ---- ==== image ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: all items Fully qualified URL to an external image resource to represent this item in playlist- or channel browser. This can be an video thumbnail, channel logo or whatever you like. If the corresponding item is a not of type //channel// the image is also displayed as "opener" if item is exported into the //blog mode// incarnation of Projekktor. ---- ==== captions ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items Fully qualified URL to an external "timed text" XML resource to generate captions for corresponding video. ---- ==== audio ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items Fully qualified URL to an external "audio comment" MP3 resource to lay over the corresponding video´s sound. ---- ==== overlays ==== **Type**: //String// \\ **Default Value**: empty \\ **Applies to**: video items Fully qualified URL to an external "ad overlays" XML resource to generate dynamic, timed advertisement overlays from. ---- ==== stretch ==== **Type**: //String// \\ **Default Value**: //fill// \\ **Applies to**: video items \\ **Valid values**: //fill, keep, stretch// \\ \\ Per default videos are scaled to optimally //fill// the available video area while keeping their dimension ratios. However its possible to force different behaviors for each item. //keep// will keep the current videos dimensions regardless how small or big the video screening area is. //stretch// will stretch the video fill the whole video screening area regardless and ignore any proportions. ----