Video service

Core Service

The Video service intakes a Kaltura player ^r1 videoId and fetches the video's' associated meta data from Kaltura Media Center.

---

Table of contents

• 1. Embed video
• 2. Video data
• 3. Format poster URL
• 4. Format duration

Dependencies (1)

• Kaltura API ^[r1]

Used by (4)

• Audio player
• CTA
• Lightbox media viewer
• Video

Back links (15)

CTA (9)

• video type CTA uses the Video service to populate the CTA
• 2.1.2 | video.id && copy | pre-filled by Video service's name if not defined.
• 2.2.2 | video.id && copy | pre-filled by Video service's name if not defined.
• ...2.3.2 | video.id && heading | pre-filled by Video service's name if not defined or explicitly set to...
• ...2.3.4 | video.id && cta copy | pre-filled by Video service's duration if not defined or explicitly set to...
• ...2.4.2 | video.id && heading | pre-filled by Video service's name if not defined....
• ...2.4.4 | video.id && cta copy | pre-filled by Video service's duration if not explicitly set to false....
• ...2.5.2 | video.id && heading | pre-filled by Video service's name if not defined....
• ...2.5.4 | video.id && cta copy | pre-filled by Video service's duration if not explicitly set to false....

Lightbox media viewer (3)

• ...ID | If a Video ID is provided use the Video service to get Video data and render
• ...(default)|headingis pre-filled by ***Video service***'sname` if provided.
• ...(default)|copyhere is pre-filled by ***Video service***'sdescription` if provided.

Video (3)

• the Video service except video
• ...| undefined (default) | Caption prefilled by Video service's provided name.
• ...2 prefilled by Video service's provided image.

Resources

• r1: Kaltura API

---

1. Embed video

Embeds the video player on the page where adopter chooses.

Props

	name	description
1.1.1	videoId	The Kaltura r1 video id.
1.1.2	target	ID of HTML element placeholder.
1.1.3	overrides	Offers the ability to override any of the video options.

See Kaltura API ^r1 for what options are available.

Events

	name	description
1.2.1	play	Records event in Google analytics (GA) when video starts playing.
1.2.2	pause	Records event in GA when video is paused.
1.2.3	end	Records event in GA when video is over.

Back to top

2. Video data

Allows the adopter to get the raw video data from the Kaltura API ^r1.

Props

	name	description
2.1.1	videoId	The Kaltura r1 video id.

See Kaltura API ^r1 for more information on what data is returned.

Back to top

3. Format poster URL

Provides the adopter the ability to retrieve a poster image at a specific size for any valid video.

Props

	name	description
3.1.1	videoId	The Kaltura r1 video id.
3.1.2	width	The desired poster image width.
3.1.3	height	The desired poster image height.

Example

https://cdnsecakmi.kaltura.com/p/1773841/thumbnail/entry_id/1_9h94wo6b/width/320

Back to top

4. Format duration

The format duration method takes in a duration in either milliseconds or seconds, and formats it to hh:mm:ss or 01:25:49.

Props

	name	description
4.0.1	duration	Duration in seconds or milliseconds

Back to top