puppeteer/assets/js/c4071280.93e94343.js

/*! For license information please see c4071280.93e94343.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[56913],{7360:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var n=r(85893),s=r(11151);const i={sidebar_label:"ScreencastOptions"},d="ScreencastOptions interface",o={id:"api/puppeteer.screencastoptions",title:"ScreencastOptions interface",description:"Signature:",source:"@site/versioned_docs/version-21.6.0/api/puppeteer.screencastoptions.md",sourceDirName:"api",slug:"/api/puppeteer.screencastoptions",permalink:"/api/puppeteer.screencastoptions",draft:!1,unlisted:!1,tags:[],version:"21.6.0",frontMatter:{sidebar_label:"ScreencastOptions"},sidebar:"api",previous:{title:"ResponseForRequest",permalink:"/api/puppeteer.responseforrequest"},next:{title:"ScreenRecorder",permalink:"/api/puppeteer.screenrecorder"}},c={},l=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function p(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"screencastoptions-interface",children:"ScreencastOptions interface"}),"\n",(0,n.jsx)(t.h4,{id:"signature",children:"Signature:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-typescript",children:"export interface ScreencastOptions\n"})}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Property"}),(0,n.jsx)(t.th,{children:"Modifiers"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"crop"}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/api/puppeteer.boundingbox",children:"BoundingBox"})}),(0,n.jsx)(t.td,{children:"Specifies the region of the viewport to crop."}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"ffmpegPath"}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsxs)(t.td,{children:[(0,n.jsxs)("p",{children:["Path to the [ffmpeg](",(0,n.jsx)(t.a,{href:"https://ffmpeg.org/",children:"https://ffmpeg.org/"}),")."]}),(0,n.jsxs)("p",{children:["Required if ",(0,n.jsx)("code",{children:"ffmpeg"})," is not in your PATH."]})]}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"path"}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(t.td,{children:"`${string}.webm`"}),(0,n.jsx)(t.td,{children:"File path to save the screencast to."}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"scale"}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsxs)(t.td,{children:[(0,n.jsx)("p",{children:"Scales the output video."}),(0,n.jsxs)("p",{children:["For example, ",(0,n.jsx)("code",{children:"0.5"})," will shrink the width and height of the output video by half. ",(0,n.jsx)("code",{children:"2"})," will double the width and height of the output video."]})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"1"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"speed"}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsxs)(t.td,{children:[(0,n.jsx)("p",{children:"Specifies the speed to record at."}),(0,n.jsxs)("p",{children:["For example, ",(0,n.jsx)("code",{children:"0.5"})," will slowdown the output video by 50%. ",(0,n.jsx)("code",{children:"2"})," will double the speed of the output video."]})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"1"})})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},75251:(e,t,r)=>{var n=r(67294),s=Symbol.for("react.element"),i=Symbol.for("react.fragment"),d=Object.prototype.hasOwnProperty,o=n.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,c={key:!0,ref:!0,__self:!0,__source:!0};function l(e,t,r){var n,i={},l=null,p=null;for(n in void 0!==r&&(l=""+r),void 0!==t.key&&(l=""+t.key),void 0!==t.ref&&(p=t.ref),t)d.call(t,n)&&!c.hasOwnProperty(n)&&(i[n]=t[n]);if(e&&e.defaultProps)for(n in t=e.defaultProps)void 0===i[n]&&(i[n]=t[n]);return{$$typeof:s,type:e,key:l,ref:p,props:i,_owner:o.current}}t.Fragment=i,t.jsx=l,t.jsxs=l},85893:(e,t,r)=>{e.exports=r(75251)},11151:(e,t,r)=>{r.d(t,{Z:()=>o,a:()=>d});var n=r(67294);const s={},i=n.createContext(s);function d(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);