Media Object Server (MOSδ
Protocol v2.8.3

MOS Protocol version 2.8.3
Document Revision 548

Revision Date: Friday, August  11, 2006

Copyright Notice

Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006 All Rights Reserved.

License

This document is provided to You under the conditions outlined below.  These conditions are designed to guarantee the integrity of the MOSδ Protocol and to ensure the compatibility of solutions implementing the MOSδ Protocol.  Use or implementation of the MOSδ Protocol as described herein, may only occur if You agree to these conditions.  Failure to follow these conditions shall void this license.  “You” shall mean you as an individual, or, where appropriate, the company or other entity on whose behalf you are using this document, and includes any entity which controls, is controlled by, or is under common control with You.

 

You must agree to the following in order to use the MOSδ Protocol:

 

1.      You must use and implement all messages defined by the MOS protocol MOS 2.8.3 Profiles  listed below per the profiles supported by your device.

2.      You may not modify message names, order of defined tags within a message, tag structure, defined values, standards and constants.

3.      You may not process messages in a means that is dependent on non-standard messages, tags or structures.

4.      You may add additional tags to messages, but the modified messages must contain the defined minimum required tags for each message, in the order defined by this document.

5.      Implementations of the MOS Protocol following the above guidelines may claim to be “MOSδ Compatible” or “MOS v2.8.3 Compatible”

6.      If You add additional tags, it is strongly recommended these be included and encapsulated only within the provided <mosExternalMetadata> structure and not inserted into the pre-defined body of the message.

7.      You are not allowed to make representations of MOS Compatibility unless you have followed these guidelines.

Abstract

MOS is a seven year old, evolving protocol for communications between Newsroom Computer Systems (NCS) and Media Object Servers (MOS) such as Video Servers, Audio Servers, Still Stores, and Character Generators.  The MOS Protocol development is supported through cooperative collaboration among equipment vendors, software vendors and end users.

Status of this document

This document reflects changes to the MOS protocol discussed during the MOS meetings at NAB 2006 and IBC 2005 and is referred to as MOS v2.8.3.  This is the final draft.  Changes are summarized here.

How to use this document

The document contains bookmarks and hyperlinks.  The Table of Contents and other areas contain underlined phrases.  Depending on the viewer application used, clicking or double clicking on underlined links will take the viewer to the relevant portion of the document.

 

Please make special note of the Profiles section which provides context for the use of command messages which are later defined in detail.

 

Examples of each MOS message and data structure are included.  These messages may be used for testing.  Developers are encouraged to cut these messages from the document, change the value of ID tags as appropriate, and paste the modified messages into validation tools.  Other than these example messages, validation tools are not provided by the MOS Group.

 

 

 


Media Object Server Protocol v2.8.3

Table of Contents

 

1.      Introduction

 

2.      MOS Profiles

 

2.1.  Profile 0 – Basic Communication

 

2.2.  Profile 1 -  Basic Object Based Workflow

 

2.3.  Profile 2 – Basic Running Order / Content List Workflow

 

2.4.  Profile 3 – Advanced Object Based Workflow

 

2.5.  Profile 4 – Advanced RO/Content List Workflow

 

2.6.  Profile 5 – Item Control

 

2.7.  Profile 6 – MOS Redirection

 

2.8. Profile 7 – MOS RO/Content List Modification

 

3.      Media Object Server Protocol Message Definition

 

 

“mos” (Media Object Server) family of messages

 

3.1.     Basic Object Communication

3.1.1.                             mosAck - Acknowledge MOS Object Description

3.1.2.                             mosObj - MOS Object Description

3.1.3.                             mosReqObj - Request Object Description

 

3.2.     Object Resynchronization / Rediscovery

3.2.1.                             mosReqAll - Request All Object Data from MOS

3.2.2.                             mosListAll - Listing of All Object Data from MOS

 

 mosReqObjList family of messages

 

3.2.3                               mosReqSearchableSchema

3.2.4                               mosListSearchableSchema

3.2.5               mosReqObjList

3.2.6                     mosObjList

 

3.3.     Object and Item Management

3.3.1.                             mosObjCreate – Mos Object Create

3.3.2.                              mosItemReplace – Replace an Item Reference in an NCS        Story with updated Item sent from the MOS

3.3.3               mosReqObjAction – NCS requests action on MOS object

 

“ro” (Running Order) family of messages

 

3.4.     ro  Playlist Construction

3.4.1.                             roAck - Acknowledge Running Order

3.4.2.                             roCreate – Create Running Order

3.4.3.                             roReplace - Replace Running Order

3.4.4.                             roMetadataReplace – Replace the metadata associated with a RO Playlist

3.4.5.                             roDelete - Delete Running Order

 

3.5.     ro Synchronization, Discovery & Status

3.5.1.                             roReq - Request Running Order

3.5.2.                             roList - List Running Order

3.5.3.                             roReqAll - Request All Running Order Descriptions

3.5.4.                             roListAll - List All Running Order Descriptions

3.5.5.                             roStat - Status of a MOS Running Order

3.5.6.                             roReadyToAir - Identify a Running Order as Ready to Air

 

3.6.     ro Story and Item Sequence Modification

 

NOTE: The following messages are included only for backwards compatibility with MOS v2.6 and have been replaced by 3.6.12 roElementAction in MOS version 2.8.  These messages will be dropped from future versions of the Protocol.

 

3.6.1.                             roStoryAppend - Append Stories to Running Order

3.6.2.                             roStoryInsert - Insert Stories in Running Order

3.6.3.                             roStoryReplace - Replace Story with Another in a Running Order

3.6.4.                             roStoryMove – Move a Story to a specific location in a Running Order

3.6.5.                             roStorySwap - Swap Positions of Stories in Running Order

3.6.6.                             roStoryDelete - Delete Stories from Running Order

3.6.7.                             roStoryMoveMultiple – Move one or more stories to a new position in the playlist

3.6.8.                             roItemInsert – Insert Items in Story

3.6.9.                             roItemReplace – Replace an Item with one or more Items in a Story

3.6.10.            roItemMoveMultiple – Move one or more Items to a specified position within a Story

3.6.11.            roItemDelete – Delete Items in Story

3.6.12.            roElementAction – Performs specific Action on a Running Order 

 

 

3.7.     ro Control and Status feedback

 

3.7.1.                             roItemStat - Status of a Single Item in a MOS Running Order

3.7.2.              roElementStat – Status of a Single Element in a MOS Running Order

3.7.3.                             roItemCue – Notification of an Item Event

3.7.4.                             roCtrl – Running Order Control

 

3.8.     Metadata Export

3.8.1.                             roStorySend – Sends story information, including body, from Running Order

 

 

 3.9.     MOS RO/Content List Modification

3.9.1.                             roReqStoryAction – MOS requests action on NCS story

 

4.      Other messages and data structures

 

4.1.     Other messages and data structures

4.1.1.                             heartbeat - Connection Confidence Indicator

4.1.2.                             reqMachInfo - Request Machine Information

4.1.3.                             listMachInfo - Machine Description List

4.1.4.                             mosExternalMetadata – Method for including and transporting Metadata defined external to MOS

4.1.5.                             mosItemReference – Metadata block transferred by ActiveX Controls

4.1.6.                             messageID – Unique Identifier for Requests

4.1.7.                             objPaths – Unambiguous pointers to media files

 

 

5. ActiveX Control Specification

 

 

5.1  Methods, Events and Data Types

 

5.2  Behavior

 

5.3 ActiveX Communication messages

5.3.1.                             ncsAck

5.3.2.                             ncsReqAppInfo

5.3.3.                             ncsAppInfo

5.3.4.                             ncsReqAppMode

5.3.5.                             ncsStoryRequest

5.3.6.                             ncsItemRequest

5.3.7.                             roStorySend