IBM Books

Image, Audio, and Video Extenders Administration and Programming

DBvBuildStoryboardFile


Image Audio Video
    X

Creates a shot catalog file and builds entries in the file for all the shots in a video. The source video can be in a database or in a file. For each shot, the API stores the shot number, starting frame number, ending frame number, and information for at least one representative frame. Values in the DBvStoryboardCtrl data structure determine how many representative frames are identified for a shot. For shots whose length is below a threshold value in DBvStoryboardCtrl, the API identifies one representative frame. For shots whose length is between a lower and upper threshold value in DBvStoryboardCtrl, the API identifies two representative frames. For shots whose length is above the upper threshold value in DBvStoryboardCtrl, the API identifies three representative frames. The representative frame information includes its frame number and the name of the file that contains the frame content. This information can be used to display a storyboard, that is, a visual summary of a video.

Authorization

Insert, Control

Library file
OS/2 and Windows AIX, HP-UX, and Solaris
dmbshot.lib libdmbshot.a (AIX)

libdmbshot.sl (HP-UX)

libdmbshot.so (Solaris)

Include file

dmbshot.h

Syntax

long DBvBuildStoryboardFile(
      char *fileName,
      DBvIOType *video,
      DBvShotControl *shotCtrl,
      DBvStoryBoardCtrl *sbCtrl
            );

Parameters

catalogName (in)
The pointer to the name of the shot catalog file.

video (in)
The pointer to the video structure.

shotCtrl (in)
The pointer to the shot control structure

sbCtrl (in)
The pointer to the storyboard control structure.

Error codes

MMDB_SUCCESS
API call processed successfully.

MMDB_RC_NO_AUTH
Caller does not have the proper access authority.

MMDB_RC_INVALID_CATALOG
The catalog is not valid or does not exist.

Examples

Create a shot catalog file that is named hotshots and fill it with data for all the shots in a video:

#include <dmbshot.h>
 
rc = DBvBuildStoryboardFile("hotshots",
       video, &shotCtrl, &sbCtrl);


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]