pyams_content.component.video.provider package ⊞

class pyams_content.component.video.provider.CustomVideoProvider[source]

Bases: object

Custom video provider

label = 'Other provider'
settings_interface = <InterfaceClass pyams_content.component.video.provider.interfaces.ICustomVideoSettings>
weight = 99
class pyams_content.component.video.provider.CustomVideoSettings[source]

Bases: persistent.Persistent

Custom video provider settings

integration_code

Integration code: Please select integration code provided by your video provider, and paste it here

class pyams_content.component.video.provider.CustomVideoSettingsContentChecker(context)[source]

Bases: pyams_content.features.checker.BaseContentChecker

Custom video settings content checker

inner_check(request)[source]
label = 'Custom video settings'
class pyams_content.component.video.provider.VideoProvidersVocabulary(context)[source]

Bases: zope.schema.vocabulary.SimpleVocabulary

Video providers vocabulary

interface = <InterfaceClass pyams_content.component.video.interfaces.IExternalVideoProvider>
pyams_content.component.video.provider.custom_video_provider_settings_factory(context)[source]

Custom video provider settings factory

pyams_content.component.video.provider.custom_video_settings_factory(context)[source]

Custom video settings factory

pyams_content.component.video.provider.dailymotion

class pyams_content.component.video.provider.dailymotion.DailymotionVideoProvider[source]

Bases: object

Dailymotion video provider

settings_interface = <InterfaceClass pyams_content.component.video.provider.interfaces.IDailymotionVideoSettings>
class pyams_content.component.video.provider.dailymotion.DailymotionVideoSettings[source]

Bases: persistent.Persistent

Dailymotion video settings

allow_fullscreen

Allow full screen?: If ‘yes’, video can be displayed in full screen

allow_sharing

Allow sharing?: If ‘no’, video sharing will be disabled

autoplay

Auto play?: If ‘yes’, video is started automatically on page load

height

Video height: Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

show_branding

Show branding?: If ‘yes’, Dailymotion branding will be displayed

show_commands

Show commands?: Show video player commands

show_endscreen

Show end screen?: Show end screen when video end

show_info

Show video info?: If ‘no’, video title and information won’t be displayed

start_at

Start at: Position at which to start video, in ‘seconds’ or ‘minutes:seconds’ format

ui_theme

UI theme: Default base color theme

video_id
width

Video width: Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

class pyams_content.component.video.provider.dailymotion.DailymotionVideoSettingsContentChecker(context)[source]

Bases: pyams_content.features.checker.BaseContentChecker

Dailymotion video settings content checker

inner_check(request)[source]
label = 'Dailymotion settings'
pyams_content.component.video.provider.dailymotion.dailymotion_video_provider_settings_factory(context)[source]

Dailymotion video provider settings factory

pyams_content.component.video.provider.dailymotion.dailymotion_video_settings_factory(context)[source]

Dailymotion video settings factory

pyams_content.component.video.provider.interfaces

interface pyams_content.component.video.provider.interfaces.ICustomVideoSettings[source]

Extends: pyams_content.component.video.interfaces.IExternalVideoSettings

Custom external video provider settings

integration_code

Integration code

Please select integration code provided by your video provider, and paste it here

Implementation:zope.schema.Text
Read Only:False
Required:True
Default Value:None
Allowed Type:str
interface pyams_content.component.video.provider.interfaces.IDailymotionVideoSettings[source]

Extends: pyams_content.component.video.interfaces.IExternalVideoSettings

Dailymotion video provider settings

video_id

Video ID

To get video ID, just use the ‘Share’ button in Dailymotion platform, click on “Copy link” and paste the given URL here

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
start_at

Start at

Position at which to start video, in ‘seconds’ or ‘minutes:seconds’ format

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:‘0:00’
Allowed Type:str
autoplay

Auto play?

If ‘yes’, video is started automatically on page load

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
show_info

Show video info?

If ‘no’, video title and information won’t be displayed

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
show_commands

Show commands?

Show video player commands

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
ui_theme

UI theme

Default base color theme

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘dark’
show_branding

Show branding?

If ‘yes’, Dailymotion branding will be displayed

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
show_endscreen

Show end screen?

Show end screen when video end

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
allow_fullscreen

Allow full screen?

If ‘yes’, video can be displayed in full screen

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
allow_sharing

Allow sharing?

If ‘no’, video sharing will be disabled

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
width

Video width

Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:720
Allowed Type:int
height

Video height

Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:405
Allowed Type:int
interface pyams_content.component.video.provider.interfaces.IVimeoVideoSettings[source]

Extends: pyams_content.component.video.interfaces.IExternalVideoSettings

Vimeo video provider settings

video_id

Video ID

To get video ID, just use the ‘Share’ button in Vimeo platform, click on “Link” entry and copy/paste the given URL here

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
show_title

Show title?

If ‘no’, video title won’t be displayed

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
show_signature

Show signature?

If ‘no’, video’s author signature won’t be displayed

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
color

Infos color

Color used for title and signature

Implementation:pyams_utils.schema.ColorField
Read Only:False
Required:True
Default Value:‘ffffff’
Allowed Type:str
autoplay

Auto play?

If ‘yes’, video is started automatically on page load

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
loop

Loop playback?

If ‘yes’, video is played indefinitely

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
allow_fullscreen

Allow full screen?

If ‘yes’, video can be displayed in full screen

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
width

Video width

Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:720
Allowed Type:int
height

Video height

Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:405
Allowed Type:int
interface pyams_content.component.video.provider.interfaces.IYoutubeVideoSettings[source]

Extends: pyams_content.component.video.interfaces.IExternalVideoSettings

Youtube video provider settings

video_id

Video ID

To get video ID, just use the ‘Share’ button in Youtube platform and copy/paste the given URL here

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
start_at

Start at

Position at which to start video, in ‘seconds’ or ‘minutes:seconds’ format

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:‘0:00’
Allowed Type:str
stop_at

Stop at

Position at which to stop video, in ‘seconds’ or ‘minutes:seconds’ format

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
autoplay

Auto play?

If ‘yes’, video is started automatically on page load

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
loop

Loop playback?

If ‘yes’, video is played indefinitely

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
show_commands

Show commands?

Show video player commands

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
hide_branding

Hide branding?

If ‘no’, Youtube branding will be displayed

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool

Show related videos?

Show related videos when video end

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
allow_fullscreen

Allow full screen?

If ‘yes’, video can be displayed in full screen

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
disable_keyboard

Disable keyboard?

If ‘yes’, video player can’t be controlled via keyboard shortcuts

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
width

Video width

Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:720
Allowed Type:int
height

Video height

Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

Implementation:zope.schema.Int
Read Only:False
Required:True
Default Value:405
Allowed Type:int

pyams_content.component.video.provider.vimeo

class pyams_content.component.video.provider.vimeo.VimeoVideoProvider[source]

Bases: object

Vimeo video provider

settings_interface = <InterfaceClass pyams_content.component.video.provider.interfaces.IVimeoVideoSettings>
class pyams_content.component.video.provider.vimeo.VimeoVideoSettings[source]

Bases: persistent.Persistent

Vimeo video settings

allow_fullscreen

Allow full screen?: If ‘yes’, video can be displayed in full screen

autoplay

Auto play?: If ‘yes’, video is started automatically on page load

color

Infos color: Color used for title and signature

height

Video height: Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

loop

Loop playback?: If ‘yes’, video is played indefinitely

show_signature

Show signature?: If ‘no’, video’s author signature won’t be displayed

show_title

Show title?: If ‘no’, video title won’t be displayed

video_id
width

Video width: Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

class pyams_content.component.video.provider.vimeo.VimeoVideoSettingsContentChecker(context)[source]

Bases: pyams_content.features.checker.BaseContentChecker

Vimeo video settings content checker

inner_check(request)[source]
label = 'Vimeo settings'
pyams_content.component.video.provider.vimeo.vimeo_video_provider_settings_factory(context)[source]

Vimeo video provider settings factory

pyams_content.component.video.provider.vimeo.vimeo_video_settings_factory(context)[source]

Vimeo video settings factory

pyams_content.component.video.provider.youtube

class pyams_content.component.video.provider.youtube.YoutubeVideoProvider[source]

Bases: object

Youtube video provider

settings_interface = <InterfaceClass pyams_content.component.video.provider.interfaces.IYoutubeVideoSettings>
class pyams_content.component.video.provider.youtube.YoutubeVideoSettings[source]

Bases: persistent.Persistent

Youtube video settings

allow_fullscreen

Allow full screen?: If ‘yes’, video can be displayed in full screen

autoplay

Auto play?: If ‘yes’, video is started automatically on page load

disable_keyboard

Disable keyboard?: If ‘yes’, video player can’t be controlled via keyboard shortcuts

height

Video height: Initial video frame height; mandatory for old browsers but may be overridden by presentation skin

hide_branding

Hide branding?: If ‘no’, Youtube branding will be displayed

loop

Loop playback?: If ‘yes’, video is played indefinitely

show_commands

Show commands?: Show video player commands

Show related videos?: Show related videos when video end

start_at

Start at: Position at which to start video, in ‘seconds’ or ‘minutes:seconds’ format

stop_at

Stop at: Position at which to stop video, in ‘seconds’ or ‘minutes:seconds’ format

video_id
width

Video width: Initial video frame width; mandatory for old browsers but may be overridden by presentation skin

class pyams_content.component.video.provider.youtube.YoutubeVideoSettingsContentChecker(context)[source]

Bases: pyams_content.features.checker.BaseContentChecker

Youtube video settings content checker

inner_check(request)[source]
label = 'Youtube settings'
pyams_content.component.video.provider.youtube.youtube_video_provider_settings_factory(context)[source]

Youtube video provider settings factory

pyams_content.component.video.provider.youtube.youtube_video_settings_factory(context)[source]

Youtube video settings factory