Cisco Video Surveillance Manager API Reference, Release 6.3.2
Index

Table Of Contents

A - B - C - D - E - F - G - H - I - J - L - M - O - P - R - S - T - U - V - W - X - Y - Z

Index

A

addToSync 6-22

archive

clip, creating 4-22

creating 6-51

details 4-15, 4-18

listing

all 4-12

running 4-13

mediatype 4-14

monitoring

detail 4-20

summary 4-21

play rate

getting 6-37

setting 6-17

removing 4-11

renaming 4-8

seeking to

percentage 6-20

UTC time 6-19

segment loop, playing 6-18

starting 4-2

stopping 4-10

updating 4-5

archive commands

overview 1-2

summary 4-1

archive video

one frame in playback direction 6-11

one frame opposite playback direction 6-12

AxClient

information 6-25

version number 6-27

AxClient API methods

overview 1-2

programming notes

C# 1-3

JavaScript 1-3

summary 6-1

B

base rectangle color

getting 6-63

setting 6-62

C

C#, programming notes 1-3

callback

invoking when

archive starts 6-77

archive stops 6-76

playback starts 6-84

playback state changes 6-87

play rate changes 6-79

save clip finishes 6-81

seek time changes 6-83

start time changes 6-85

stop time changes 6-89

summary 6-75

camera control 2-5

changing view rectangle size 6-71

clip

creating 6-48

saving in WMV format 6-49

starting 5-18

stopping 5-18

close 6-16

closing stream 6-16

codec subtype 6-41

color, transparent

getting 6-61

setting 6-60

controlling

video operations 6-2

VMR display 6-57

createCiscoVideoArchive 6-51

createSyncId 6-24

creating

archive 6-51

archive clip 4-22

clips 6-48

snapshots 6-48

sync ID 6-24

current time in UTC format 6-31

D

deltaMove 6-72

DIB snapshot 6-55

DIB snapshot, properly formatted 6-54

disabling event 5-10

display

height 6-45

width 6-44

E

enabling event 5-9

error text description 6-38

event

clip

starting 5-18

stopping 5-18

configuration

motion 5-21

single alarm 5-22

soft trigger 5-22

disabling 5-10

enabling 5-9

handling

motion 5-21

single alarm 5-22

soft trigger 5-22

information 5-19

removing 5-11

setup 5-2

triggering 5-13

event commands

overview 1-2

summary 5-1

F

framerate or bitrate, proxy 3-16

frame size, proxy 3-23

G

getAlpha 6-59

getBaseRectColor 6-63

getCiscoHD 6-26

getContentType 6-34

getCurrentSource 6-35

getDisplayHeight 6-45

getDisplayWidth 6-44

getErrorText 6-38

getPlayrateEx 6-37

getProfiles 6-39

getProfilesSSV 6-40

getRecordrateEx 6-36

getSnapshotDIB 6-54

getSnapshotWin32DIB 6-55

getState 6-33

getStreamCodecSubtype 6-41

getting

archive

details 4-15

mediatype 4-14

monitoring detail 4-20

monitoring summary 4-21

play rate 6-37

array of supported WMV profiles 6-40

AxClient version number 6-27

base rectangle color 6-63

codec subtype 6-41

current time in UTC format 6-31

DIB snapshot 6-55

display

height 6-45

width 6-44

error text description 6-38

event information 5-19

HD camera indication 6-26

list of supported WMV profiles 6-39

media type 6-34

original start time in UTC format 6-32

player state 6-33

properly formatted DIB snapshot 6-54

proxy

device 3-22

framerate or bitrate 3-16

frame size 3-23

media type 3-15

model 3-20

quality, MJPEG 3-17

source 3-14

status 3-21

video height 3-19

video width 3-18

record rate 6-36

RTSP stream from VSMS 2-13

SDP information for video stream 2-3

seek time in UTC format 6-28

source URL 6-35

start time in UTC format 6-29

stop time in UTC format 6-30

stream height 6-43

stream width 6-42

transparent color 6-61

view rectangle

x coordinate 6-46

y coordinate 6-47

VMR display mode 6-68

VMR transparency level 6-59

VSMS version 2-2

zoom rectangle

color 6-65

factor 6-70

getTransparent 6-61

getUTCCurrentTime 6-31

getUTCOriginalStartTime 6-32

getUTCSeekTime 6-28

getUTCStartTime 6-29

getUTCStopTime 6-30

getVersion 6-27

getVideoHeight 6-43

getVideoWidth 6-42

getVmrDisplayMode 6-68

getX 6-46

getY 6-47

getZoomFactor 6-70

getZoomRectColor 6-65

H

HD camera indication 6-26

height, stream 6-43

hiding time stamp 6-21

I

invoking callback when

archive starts 6-77

archive stops 6-76

playback starts 6-84

playback state changes 6-87

play rate changes 6-79

save clip finishes 6-81

seek time changes 6-83

start time changes 6-85

stop time changes 6-89

J

JavaScript, programming notes 1-3

L

listing

all archives 4-12

all proxies 3-12

running archives 4-13

looping archive segment 6-18

M

media devices, supported B-1

media type 6-34

MJPEG proxy quality 3-17

motion event configuration 5-21

move 6-71

moving zoom rectangle 6-72

mtStartStream 6-3

mtStartStreamWait 6-7

mtStreamStarting 6-5

O

obtaining

AxClient information 6-25

video stream information 6-25

original start time in UTC format 6-32

P

pause 6-13

pausing

video stream 6-13

video stream after start 6-7

player state 6-33

playForward 6-8

playing

archive segment loop 6-18

paused video stream 6-14

video stream in forward direction 6-8

video stream in reverse direction 6-10

playResume 6-14

playRewind 6-10

programming notes

C# 1-3

JavaScript 1-3

proxy

device 3-22

framerate or bitrate 3-16

frame size 3-23

listing all 3-12

media type 3-15

model 3-20

quality, MJPEG 3-17

source 3-14

starting 3-2

status 3-21

stopping 3-10

updating 3-6

video height 3-19

video width 3-18

proxy commands

overview 1-2

summary 3-1

R

record rate 6-36

removeFromSync 6-23

removing

archive 4-11

event 5-11

playback from sync control 6-23

renaming archive 4-8

repeatUTCSegment 6-18

resizeVideoWindow 6-73

resizing video window 6-73

returning status of started video stream 6-5

RTSP stream, getting from VSMS 2-13

S

saveInPortableFormat 6-49

saving clip in WMV format 6-49

seek archive to

archive percentage 6-20

UTC time 6-19

seek time in UTC format 6-28

seekToPercentage 6-20

seekToUTCTime 6-19

sending

event notification 5-13

event notification from trigger device to VSMS 5-13

setAlpha 6-58

setBaseRectColor 6-62

setOnEndOfStream 6-76

setOnMtStartStreamDone 6-77

setOnPlayrateChanged 6-79

setOnSaveResponse 6-81

setOnSeekTimeChanged 6-83

setOnStartOfStream 6-84

setOnStartTimeChanged 6-85

setOnStateChanged 6-87

setOnStopTimeChanged 6-89

setPlayrateEx 6-17

setTimeStampRect 6-66

setting

archive play rate 6-17

base rectangle color 6-62

time stamp rectangle 6-66

trasparent color 6-60

VMR display mode 6-67

VMR transparency level 6-58

zoom rectangle

color 6-64

factor 6-69

setting up

callback 6-75

event 5-2

setTransparent 6-60

setVmrDisplayMode 6-67

setZoomFactor 6-69

setZoomRectColor 6-64

showing time stamp 6-21

showTimestamp 6-21

single alarm event configuration 5-22

snapshot

creating 6-48

from video frame 6-53

soft trigger event configuration 5-22

source URL 6-35

starting

archive 4-2

event clip 5-18

proxy 3-2

video stream 6-3

start time in UTC format 6-29

status, proxy 3-21

stepForward 6-11

stepping archive video

one frame in playback direction 6-11

one frame opposite playback direction 6-12

stepRewind 6-12

stopping

archive 4-10

event clip 5-18

proxy 3-10

streaming of live or archive video 6-15

stop time in UTC format 6-30

stream

closing 6-16

height 6-43

SDP information 2-3

width 6-42

subtype, codec 6-41

supported media devices B-1

sync ID 6-24

T

time stamp, showing or hiding 6-21

time stamp rectangle, setting 6-66

transparency level, VMR

getting 6-59

setting 6-58

transparent color

getting 6-61

trasparent color

setting 6-60

triggering VSMS event 5-13

U

updating

archive 4-5

proxy 3-6

URL-based media server API commands

archive commands 1-2

event commands 1-2

proxy commands 1-2

VSMS commands 1-1

URL of loaded source 6-35

UTC

current time 6-31

original start time 6-32

playing an archive segment loop 6-18

seek archive to 6-19

seek time 6-28

start time 6-29

stop time 6-30

V

version number, AxClient 6-27

video

height 3-19

operations 6-2

width 3-18

video stream

information 6-25

pausing 6-13

pausing after start 6-7

playing

forward direction 6-8

reverse direction 6-10

resume playing after pause 6-14

returning start status 6-5

SDP information 2-3

starting 6-3

viewing JPEG frames 3-11

view rectangle, changing size 6-71

VMR

display 6-57

turning on with C# A-1

VMR display mode

getting 6-68

setting 6-67

VMR transparency level

getting 6-59

setting 6-58

VSMS commands

overview 1-1

summary 2-1

VSMS version 2-2

W

width, stream 6-42

WMV profiles

array of supported 6-40

list of supported 6-39

X

x coordinate, view rectangle 6-46

Y

y coordinate, view rectangle 6-47

Z

zoom rectangle

color

getting 6-65

setting 6-64

factor

getting 6-70

setting 6-69

moving 6-72